Package org.opensearch.common.annotation.processor

Class ApiAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.opensearch.common.annotation.processor.ApiAnnotationProcessor

All Implemented Interfaces:

Processor

@InternalApi
@SupportedAnnotationTypes("org.opensearch.common.annotation.*")
public class ApiAnnotationProcessor
extends AbstractProcessor

The annotation processor for API related annotations: DeprecatedApi, ExperimentalApi, InternalApi and PublicApi.

The checks are built on top of the following rules:

• introspect each type annotated with PublicApi, DeprecatedApi or ExperimentalApi, filtering out package-private declarations
• make sure those leak only PublicApi, DeprecatedApi or ExperimentalApi types as well (exceptions, method return values, method arguments, method generic type arguments, class generic type arguments, annotations)
• recursively follow the type introspection chains to enforce the rules down the line

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ApiAnnotationProcessor()

Method Summary

Modifier and Type	Method	Description
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment round)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Details

ApiAnnotationProcessor

public ApiAnnotationProcessor()

Method Details

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getSupportedOptions

public Set<String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

Overrides:

getSupportedOptions in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment round)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor