Package org.apache.pinot.spi.annotations

Class InterfaceAudience

java.lang.Object

org.apache.pinot.spi.annotations.InterfaceAudience

@Public
@Evolving
public class InterfaceAudience
extends Object

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

• Public classes that are not marked with this annotation must be considered by default as InterfaceAudience.Private.
• External application developers depending on Pinot must only use classes that are marked InterfaceAudience.Public. Do not depend on classes without an explicit InterfaceAudience.Public annotation as these classes could be removed or change in incompatible ways.
• Methods may have a different annotation that it is more restrictive compared to the audience classification of the class. Example: A class might be InterfaceAudience.Public, but a method may be InterfaceAudience.LimitedPrivate

The annotation is borrowed from a similar Apache Hadoop annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InterfaceAudience.LimitedPrivate	Intended only for the project(s) specified in the annotation.
static interface	InterfaceAudience.Private	Intended for use only within Pinot itself.
static interface	InterfaceAudience.Public	Intended for use by any project or application.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait