InterfaceAudience.Private (Apache Yetus - Audience Annotations Component 0.2.1 API)

java.lang.Object
-
- org.apache.yetus.audience.InterfaceAudience
-

-
-
-
```
@InterfaceAudience.Public
- @InterfaceStability.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.
- All public classes must have InterfaceAudience annotation.
-
- Public classes that are not marked with this annotation must be - considered by default as InterfaceAudience.Private.
- External applications must only use classes that are marked - InterfaceAudience.Public. Avoid using non public classes as these classes - could be removed or change in incompatible ways.
- Some projects may choose to give special consideration to related - projects. Such consideration can be done by using the InterfaceAudience.LimitedPrivate - annotation with a named set of projects.
- 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 -
-

- -

Nested Class Summary

- - - - - - - - - - - - - - - - - - -

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InterfaceAudience.LimitedPrivate` - Intended only for the project(s) specified in the annotation. -
`static interface`	`InterfaceAudience.Private` - Intended for use only within a given project. -
`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
-

-
-

@Documented
- @Retention(value=RUNTIME)
-public static @interface InterfaceStability.Evolving

Evolving, but can break compatibility at minor release (i.e. m.x)

-
-
-
```
@Documented
- @Retention(value=RUNTIME)
-public static @interface InterfaceStability.Stable
```
-
Can evolve while retaining compatibility for minor release boundaries.; - can break compatibility only at major release (ie. at m.0).
-

-
-
-
```
@Documented
- @Retention(value=RUNTIME)
-public static @interface InterfaceStability.Unstable
```
-
No guarantee is provided as to reliability or stability across any - level of release granularity.
-

java.lang.Object
-
- org.apache.yetus.audience.InterfaceStability
-

-
-
-
```
@InterfaceAudience.Public
- @InterfaceStability.Evolving
-public class InterfaceStability
-extends Object
```
-
Annotation to inform users of how much to rely on a particular package, - class or method not changing over time. Currently the stability can be - InterfaceStability.Stable, InterfaceStability.Evolving or InterfaceStability.Unstable.
- -
- All classes that are annotated with InterfaceAudience.Public or - InterfaceAudience.LimitedPrivate must have InterfaceStability annotation.
- Classes that are InterfaceAudience.Private are to be considered unstable unless - a different InterfaceStability annotation states otherwise.
- Incompatible changes must not be made to classes marked as stable.
-

- -

- - -

Nested Class Summary

- - - - - - - - - - - - - - - - - - -

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InterfaceStability.Evolving` - Evolving, but can break compatibility at minor release (i.e. -
`static interface`	`InterfaceStability.Stable` - Can evolve while retaining compatibility for minor release boundaries.; - can break compatibility only at major release (ie. -
`static interface`	`InterfaceStability.Unstable` - No guarantee is provided as to reliability or stability across any - level of release granularity. -

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
InterfaceStability()
-

Constructors
Constructor and Description
`InterfaceStability()`

- -

- - -
Method Summary
-
- - - -
  Methods inherited from class java.lang.Object
  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-

- -
- - - -
  Constructor Detail
  - - - -
  - -
    InterfaceStability
    -
```
public InterfaceStability()
```
    -
  -
-

- - - - - - - - - - - - - - - - -
Packages that use InterfaceAudience.Public
Package Description
org.apache.yetus.audience
org.apache.yetus.audience.tools
-

Packages that use InterfaceAudience.Public
Package	Description
org.apache.yetus.audience
org.apache.yetus.audience.tools

- - -

Uses of InterfaceAudience.Public in org.apache.yetus.audience

- - - - - - - - - - - - - - - - -

Classes in org.apache.yetus.audience with annotations of type InterfaceAudience.Public
Modifier and Type	Class and Description
`class`	`InterfaceAudience` - Annotation to inform users of a package, class or method's intended audience. -
`class`	`InterfaceStability` - Annotation to inform users of how much to rely on a particular package, - class or method not changing over time. -

- - -

Uses of InterfaceAudience.Public in org.apache.yetus.audience.tools

- - - - - - - - - - - - - - - - - - - - -

Classes in org.apache.yetus.audience.tools with annotations of type InterfaceAudience.Public
Modifier and Type	Class and Description
`class`	`ExcludePrivateAnnotationsJDiffDoclet` - A Doclet - for excluding elements that are annotated with - `InterfaceAudience.Private` or - `InterfaceAudience.LimitedPrivate`. -
`class`	`ExcludePrivateAnnotationsStandardDoclet` - A Doclet - for excluding elements that are annotated with - `InterfaceAudience.Private` or - `InterfaceAudience.LimitedPrivate`. -
`class`	`IncludePublicAnnotationsStandardDoclet` - A Doclet - that only includes class-level elements that are annotated with - `InterfaceAudience.Public`. -

Annotation Type InterfaceAudience.Private

Annotation Type InterfaceAudience.Public

Class InterfaceAudience

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Annotation Type InterfaceStability.Evolving

Annotation Type InterfaceStability.Stable

Annotation Type InterfaceStability.Unstable

Class InterfaceStability

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InterfaceStability

Uses of Class
org.apache.yetus.audience.InterfaceAudience.LimitedPrivate

Uses of Class
org.apache.yetus.audience.InterfaceAudience.Private

Uses of Class
org.apache.yetus.audience.InterfaceAudience.Public

Uses of InterfaceAudience.Public in org.apache.yetus.audience

Uses of InterfaceAudience.Public in org.apache.yetus.audience.tools

Annotation Type InterfaceAudience.Private

Annotation Type InterfaceAudience.Public

Class InterfaceAudience

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Annotation Type InterfaceStability.Evolving

Annotation Type InterfaceStability.Stable

Annotation Type InterfaceStability.Unstable

Class InterfaceStability

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InterfaceStability

Uses of Classorg.apache.yetus.audience.InterfaceAudience.LimitedPrivate

Uses of Classorg.apache.yetus.audience.InterfaceAudience.Private

Uses of Classorg.apache.yetus.audience.InterfaceAudience.Public

Uses of InterfaceAudience.Public in org.apache.yetus.audience

Uses of InterfaceAudience.Public in org.apache.yetus.audience.tools

Uses of Class
org.apache.yetus.audience.InterfaceAudience.LimitedPrivate

Uses of Class
org.apache.yetus.audience.InterfaceAudience.Private

Uses of Class
org.apache.yetus.audience.InterfaceAudience.Public