Top Description Inners Constructors Methods
org.apache.hadoop.classification

public Class InterfaceAudience

extends Object
Class Inheritance
Annotations
@Public
@Evolving
Imports
java.lang.annotation.Documented, .Retention, .RetentionPolicy

Annotation to inform users of a package, class or method's intended audience. Currently the audience can be Public, LimitedPrivate or Private.
All public classes must have InterfaceAudience annotation.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static @interface
InterfaceAudience.LimitedPrivate

Intended only for the project(s) specified in the annotation.

public static @interface
InterfaceAudience.Private

Intended for use only within Hadoop itself.

public static @interface
InterfaceAudience.Public

Intended for use by any project or application.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

InterfaceAudienceback to summary
private InterfaceAudience()
org.apache.hadoop.classification back to summary

public @Interface InterfaceAudience.LimitedPrivate

extends Annotation
Annotations
@Documented
@Retention:RUNTIME

Intended only for the project(s) specified in the annotation. For example, "Common", "HDFS", "MapReduce", "ZooKeeper", "HBase".

Method Summary

Modifier and TypeMethod and Description
public String[]
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String[] value()
org.apache.hadoop.classification back to summary

public @Interface InterfaceAudience.Private

extends Annotation
Annotations
@Documented
@Retention:RUNTIME

Intended for use only within Hadoop itself.

Method Summary

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString
org.apache.hadoop.classification back to summary

public @Interface InterfaceAudience.Public

extends Annotation
Annotations
@Documented
@Retention:RUNTIME

Intended for use by any project or application.

Method Summary

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString