Package org.apache.yetus.audience.tools

Class ExcludePrivateAnnotationsStandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

org.apache.yetus.audience.tools.ExcludePrivateAnnotationsStandardDoclet

All Implemented Interfaces:

Doclet

Direct Known Subclasses:

IncludePublicAnnotationsStandardDoclet

@Public
@Evolving
public class ExcludePrivateAnnotationsStandardDoclet
extends StandardDoclet

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.

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.yetus.audience.tools.DocletEnvironmentProcessor	processor

Constructor Summary

Constructors

Constructor	Description
ExcludePrivateAnnotationsStandardDoclet()

Method Summary

Modifier and Type	Method	Description
String	getName()
Set<Doclet.Option>	getSupportedOptions()
boolean	run(DocletEnvironment environment)

Methods inherited from class jdk.javadoc.doclet.StandardDoclet

getSupportedSourceVersion, init

Methods inherited from class java.lang.Object

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

Field Detail

processor

protected org.apache.yetus.audience.tools.DocletEnvironmentProcessor processor

Constructor Detail

ExcludePrivateAnnotationsStandardDoclet

public ExcludePrivateAnnotationsStandardDoclet()

Method Detail

getName

public String getName()

Specified by:

getName in interface Doclet

Overrides:

getName in class StandardDoclet

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

Overrides:

getSupportedOptions in class StandardDoclet

run

public boolean run(DocletEnvironment environment)

Specified by:

run in interface Doclet

Overrides:

run in class StandardDoclet