Interface PackageElementVisitor<A>

Type Parameters:

A - The annotation required on the package or Object for any package.

All Superinterfaces:

Ordered, Toggleable

All Known Implementing Classes:

IntrospectedPackageElementVisitor, PackageConfigurationImportVisitor

public interface PackageElementVisitor<A>
extends Ordered, Toggleable

The visitor of the package elements.

Since:

4.10

Author:

Denis Stepanov

Field Summary

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default String	getPackageAnnotationName()	Retrieves the annotation name associated with the package.
default Set<String>	getSupportedAnnotationNames()
default TypeElementVisitor.VisitorKind	getVisitorKind()
default void	visitPackage(PackageElement element, VisitorContext context)	Executed when a package is encountered that matches the <E> generic.

Methods inherited from interface Ordered

getOrder

Methods inherited from interface Toggleable

isEnabled

Method Details

visitPackage

default void visitPackage(PackageElement element,
 VisitorContext context)
                   throws ProcessingException

Executed when a package is encountered that matches the <E> generic.

Parameters:

element - The package element

context - The visitor context

Throws:

ProcessingException

getSupportedAnnotationNames

default Set<String> getSupportedAnnotationNames()

Returns:

The supported default annotation names.

getVisitorKind

default TypeElementVisitor.VisitorKind getVisitorKind()

Returns:

The visitor kind.

getPackageAnnotationName

default String getPackageAnnotationName()

Retrieves the annotation name associated with the package.

Returns:

The fully qualified name of the annotation class as a string.