org.apache.yetus.audience (Apache Yetus - Audience Annotations Component 0.1.0 API)

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

Class Summary
Class	Description
InterfaceAudience	- Annotation to inform users of a package, class or method's intended audience. -
InterfaceStability	- Annotation to inform users of how much to rely on a particular package, - class or method not changing over time. -

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

Annotation Types Summary
Annotation Type	Description
InterfaceAudience.LimitedPrivate	- Intended only for the project(s) specified in the annotation. -
InterfaceAudience.Private	- Intended for use only within a given project. -
InterfaceAudience.Public	- Intended for use by any project or application. -
InterfaceStability.Evolving	- Evolving, but can break compatibility at minor release (i.e. -
InterfaceStability.Stable	- Can evolve while retaining compatibility for minor release boundaries.; - can break compatibility only at major release (ie. -
InterfaceStability.Unstable	- No guarantee is provided as to reliability or stability across any - level of release granularity. -

Class Hierarchy

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

Annotation Type Hierarchy

org.apache.yetus.audience.InterfaceStability.Stable (implements java.lang.annotation.Annotation)
org.apache.yetus.audience.InterfaceStability.Evolving (implements java.lang.annotation.Annotation)
org.apache.yetus.audience.InterfaceStability.Unstable (implements java.lang.annotation.Annotation)
org.apache.yetus.audience.InterfaceAudience.Public (implements java.lang.annotation.Annotation)
org.apache.yetus.audience.InterfaceAudience.LimitedPrivate (implements java.lang.annotation.Annotation)
org.apache.yetus.audience.InterfaceAudience.Private (implements java.lang.annotation.Annotation)

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

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

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

Classes in org.apache.yetus.audience used by org.apache.yetus.audience
Class and Description
InterfaceAudience.Public - Intended for use by any project or application. -
InterfaceStability.Evolving - Evolving, but can break compatibility at minor release (i.e. -

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

Classes in org.apache.yetus.audience used by org.apache.yetus.audience.tools
Class and Description
InterfaceAudience.Public - Intended for use by any project or application. -
InterfaceStability.Evolving - Evolving, but can break compatibility at minor release (i.e. -

java.lang.Object
-
- org.apache.yetus.audience.tools.ExcludePrivateAnnotationsJDiffDoclet
-

-
-
-
```
@InterfaceAudience.Public
- @InterfaceStability.Evolving
-public class ExcludePrivateAnnotationsJDiffDoclet
-extends Object
```
-
A Doclet - for excluding elements that are annotated with - InterfaceAudience.Private or - InterfaceAudience.LimitedPrivate. - It delegates to the JDiff Doclet, and takes the same options.
-

- -

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

Constructors
Constructor and Description
`ExcludePrivateAnnotationsJDiffDoclet()`

- -

- - -

Method Summary

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.sun.javadoc.LanguageVersion`	`languageVersion()`
`static int`	`optionLength(String option)`
`static boolean`	`start(com.sun.javadoc.RootDoc root)`
`static boolean`	`validOptions(String[][] options, - com.sun.javadoc.DocErrorReporter reporter)`

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

- -

- - -
Constructor Detail
- - - -
- -
  ExcludePrivateAnnotationsJDiffDoclet
  -
```
public ExcludePrivateAnnotationsJDiffDoclet()
```
  -
-

- -

- - -

Method Detail

- - - -

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

- - - -

start

public static boolean start(com.sun.javadoc.RootDoc root)

- - - -

optionLength

public static int optionLength(String option)

- - - -

validOptions

public static boolean validOptions(String[][] options,
-                                   com.sun.javadoc.DocErrorReporter reporter)

java.lang.Object
-
- org.apache.yetus.audience.tools.ExcludePrivateAnnotationsStandardDoclet
-

-
-
-
```
@InterfaceAudience.Public
- @InterfaceStability.Evolving
-public class ExcludePrivateAnnotationsStandardDoclet
-extends Object
```
-
A Doclet - for excluding elements that are annotated with - InterfaceAudience.Private or - InterfaceAudience.LimitedPrivate. - It delegates to the Standard Doclet, and takes the same options.
-

- -

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

Constructors
Constructor and Description
`ExcludePrivateAnnotationsStandardDoclet()`

- -

- - -

Method Summary

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.sun.javadoc.LanguageVersion`	`languageVersion()`
`static int`	`optionLength(String option)`
`static boolean`	`start(com.sun.javadoc.RootDoc root)`
`static boolean`	`validOptions(String[][] options, - com.sun.javadoc.DocErrorReporter reporter)`

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

- -

- - -
Constructor Detail
- - - -
- -
  ExcludePrivateAnnotationsStandardDoclet
  -
```
public ExcludePrivateAnnotationsStandardDoclet()
```
  -
-

- -

- - -

Method Detail

- - - -

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

- - - -

start

public static boolean start(com.sun.javadoc.RootDoc root)

- - - -

optionLength

public static int optionLength(String option)

- - - -

validOptions

public static boolean validOptions(String[][] options,
-                                   com.sun.javadoc.DocErrorReporter reporter)

java.lang.Object
-
- org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet
-

-
-
-
```
@InterfaceAudience.Public
- @InterfaceStability.Evolving
-public class IncludePublicAnnotationsStandardDoclet
-extends Object
```
-
A Doclet - that only includes class-level elements that are annotated with - InterfaceAudience.Public. - Class-level elements with no annotation are excluded. - In addition, all elements that are annotated with - InterfaceAudience.Private or - InterfaceAudience.LimitedPrivate - are also excluded. - It delegates to the Standard Doclet, and takes the same options.
-

- -

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

Constructors
Constructor and Description
`IncludePublicAnnotationsStandardDoclet()`

- -

- - -

Method Summary

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.sun.javadoc.LanguageVersion`	`languageVersion()`
`static int`	`optionLength(String option)`
`static boolean`	`start(com.sun.javadoc.RootDoc root)`
`static boolean`	`validOptions(String[][] options, - com.sun.javadoc.DocErrorReporter reporter)`

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

- -

- - -
Constructor Detail
- - - -
- -
  IncludePublicAnnotationsStandardDoclet
  -
```
public IncludePublicAnnotationsStandardDoclet()
```
  -
-

- -

- - -

Method Detail

- - - -

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

- - - -

start

public static boolean start(com.sun.javadoc.RootDoc root)

- - - -

optionLength

public static int optionLength(String option)

- - - -

validOptions

public static boolean validOptions(String[][] options,
-                                   com.sun.javadoc.DocErrorReporter reporter)

org.apache.yetus.audience

Classes

Annotation Types

Package org.apache.yetus.audience

Hierarchy For Package org.apache.yetus.audience

Class Hierarchy

Annotation Type Hierarchy

Uses of Packageorg.apache.yetus.audience

Class ExcludePrivateAnnotationsJDiffDoclet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExcludePrivateAnnotationsJDiffDoclet

Method Detail

languageVersion

start

optionLength

validOptions

Class ExcludePrivateAnnotationsStandardDoclet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExcludePrivateAnnotationsStandardDoclet

Method Detail

languageVersion

start

optionLength

validOptions

Class IncludePublicAnnotationsStandardDoclet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IncludePublicAnnotationsStandardDoclet

Method Detail

languageVersion

start

optionLength

validOptions

Uses of Classorg.apache.yetus.audience.tools.ExcludePrivateAnnotationsJDiffDoclet

Uses of Package
org.apache.yetus.audience

Uses of Class
org.apache.yetus.audience.tools.ExcludePrivateAnnotationsJDiffDoclet