org.netbeans.api.java.queries

Interface AnnotationProcessingQuery.Result

Enclosing class:

AnnotationProcessingQuery

public static interface AnnotationProcessingQuery.Result

Annotation processing configuration. The processor path is returned from ClassPath.getClassPath(org.openide.filesystems.FileObject, java.lang.String) for JavaClassPathConstants.PROCESSOR_PATH.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l) Add a ChangeListener.
Set<? extends AnnotationProcessingQuery.Trigger>	annotationProcessingEnabled() When the annotation processors should be run.
Iterable<? extends String>	annotationProcessorsToRun() Which annotation processors should be run.
Map<? extends String,? extends String>	processorOptions() Returns options passed to annotation processors ("-Akey=value").
void	removeChangeListener(ChangeListener l) Remove a ChangeListener.
URL	sourceOutputDirectory() Returns directory to which the annotation processing (during build process) generates sources, if any.

Method Detail

annotationProcessingEnabled

@NonNull
Set<? extends AnnotationProcessingQuery.Trigger> annotationProcessingEnabled()

When the annotation processors should be run.

Returns:

returns a set of triggers on which the annotation processors should be run

Since:

org.netbeans.api.java/1 1.27

annotationProcessorsToRun

@CheckForNull
Iterable<? extends String> annotationProcessorsToRun()

Which annotation processors should be run.

Returns:

if null, run all annotation processors found on the JavaClassPathConstants.PROCESSOR_PATH, otherwise only the selected processors will be run. The values should be binary names of the annotation processors.

sourceOutputDirectory

@CheckForNull
URL sourceOutputDirectory()

Returns directory to which the annotation processing (during build process) generates sources, if any.

Returns:

if not-null, a directory to which the annotation processing generates sources.

processorOptions

@NonNull
Map<? extends String,? extends String> processorOptions()

Returns options passed to annotation processors ("-Akey=value"). Options are returned in the form of a map from option key to option value. For an option with no value the corresponding value in the map is null.

Returns:

the processor-specific options

Since:

org.netbeans.api.java/1 1.26

See Also:

ProcessingEnvironment.getOptions()

addChangeListener

void addChangeListener(@NonNull
                       ChangeListener l)

Add a ChangeListener.

Parameters:

l - the listener

removeChangeListener

void removeChangeListener(@NonNull
                          ChangeListener l)

Remove a ChangeListener.

Parameters:

l - the listener