Class InterfaceAudience

java.lang.Object

org.apache.kafka.common.annotation.InterfaceAudience

@Public
public class InterfaceAudience
extends Object

Annotation to inform users of the intended audience of a particular class. The audience can be InterfaceAudience.Public or InterfaceAudience.Private; the annotations target TYPE only — methods and fields inherit the audience of their declaring class, and packages are intentionally not a granularity the checker enforces. Audience is orthogonal to InterfaceStability: a class may be public-audience and evolving-stability at the same time.

If no audience annotation is present on a class, it is assumed to be InterfaceAudience.Private (internal). External code must not depend on classes without an explicit InterfaceAudience.Public annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	InterfaceAudience.Private	Intended for internal use within Apache Kafka.
static @interface	InterfaceAudience.Public	Intended for end users of Apache Kafka.

Constructor Summary

Constructors

Constructor	Description
InterfaceAudience()

Method Summary

Methods inherited from class Object

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

Constructor Details

InterfaceAudience

public InterfaceAudience()