001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, software 013 * distributed under the License is distributed on an "AS IS" BASIS, 014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 015 * See the License for the specific language governing permissions and 016 * limitations under the License. 017 */ 018package org.apache.hadoop.classification; 019 020import java.lang.annotation.Documented; 021 022/** 023 * Annotation to inform users of a package, class or method's intended audience. 024 */ 025@InterfaceAudience.Public 026@InterfaceStability.Evolving 027public class InterfaceAudience { 028 /** 029 * Intended for use by any project or application. 030 */ 031 @Documented public @interface Public {}; 032 033 /** 034 * Intended only for the project(s) specified in the annotation. 035 * For example, "Common", "HDFS", "MapReduce", "ZooKeeper", "HBase". 036 */ 037 @Documented public @interface LimitedPrivate { 038 String[] value(); 039 }; 040 041 /** 042 * Intended for use only within Hadoop itself. 043 */ 044 @Documented public @interface Private {}; 045 046 private InterfaceAudience() {} // Audience can't exist on its own 047}