Interface PackageElement

All Superinterfaces:

AnnotatedConstruct, Element, QualifiedNameable

public interface PackageElement
extends Element, QualifiedNameable

Represents a package program element. Provides access to information about the package and its members.

API Note:

The represented package may have an explicit reference representation (either source code or executable output) or may be created from implicit information. The explicit and standalone source code construct for a package is typically a package-info.java file (JLS §7.4.1). A named package without a standalone package-info.java file can be declared in the package declaration of a top-level class or interface. Implicit information is used to model unnamed packages (JLS §7.4.2).

In the context of annotation processing, a package element can be:

• created from the initial inputs to a run of the tool
• created from source code or class files written by a processor
• queried for in the configured environment

See Java Language Specification:

7.4 Package Declarations

Since:

1.6

See Also:

• Elements.getPackageOf(Element)

Method Summary

Modifier and Type	Method	Description
TypeMirror	asType()	Returns a pseudo-type for this package.
List<? extends Element>	getEnclosedElements()	Returns the top-level classes and interfaces within this package.
Element	getEnclosingElement()	Returns the enclosing module if such a module exists; otherwise null.
Name	getQualifiedName()	Returns the fully qualified name of this package.
Name	getSimpleName()	Returns the simple name of this package.
boolean	isUnnamed()	Returns true if this is an unnamed package and false otherwise.

Methods declared in interface Element

accept, equals, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getKind, getModifiers, hashCode

Modifier and Type	Method	Description
<R,P> R	accept(ElementVisitor<R,P> v, P p)	Applies a visitor to this element.
boolean	equals(Object obj)	Returns true if the argument represents the same element as this, or false otherwise.
<A extends Annotation> A	getAnnotation(Class<A> annotationType)	Returns this construct's annotation of the specified type if such an annotation is present, else null.
List<? extends AnnotationMirror>	getAnnotationMirrors()	Returns the annotations that are directly present on this construct.
<A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)	Returns annotations of the specified type that are associated with this construct.
ElementKind	getKind()	Returns the kind of this element.
Set<Modifier>	getModifiers()	Returns the modifiers of this element, excluding annotations.
int	hashCode()	Obeys the general contract of Object.hashCode.

Method Details

asType

TypeMirror asType()

Returns a pseudo-type for this package.

Specified by:

asType in interface Element

Returns:

a pseudo-type for this package

See Also:

• NoType
• TypeKind.PACKAGE

getQualifiedName

Name getQualifiedName()

Returns the fully qualified name of this package. This is also known as the package's canonical name. For an unnamed package, an empty name is returned.

Specified by:

getQualifiedName in interface QualifiedNameable

API Note:

The fully qualified name of a named package that is not a subpackage of a named package is its simple name. The fully qualified name of a named package that is a subpackage of another named package consists of the fully qualified name of the containing package, followed by ".", followed by the simple (member) name of the subpackage.

Returns:

the fully qualified name of this package, or an empty name if this is an unnamed package

See Java Language Specification:

6.7 Fully Qualified Names and Canonical Names
7.4.1 Named Packages

getSimpleName

Name getSimpleName()

Returns the simple name of this package. For an unnamed package, an empty name is returned.

Specified by:

getSimpleName in interface Element

Returns:

the simple name of this package or an empty name if this is an unnamed package

See Also:

• getSimpleName()
• ExecutableElement.getSimpleName()
• TypeElement.getSimpleName()
• VariableElement.getSimpleName()
• ModuleElement.getSimpleName()
• RecordComponentElement.getSimpleName()

getEnclosedElements

List<? extends Element> getEnclosedElements()

Returns the top-level classes and interfaces within this package. Note that subpackages are not considered to be enclosed by a package.

Specified by:

getEnclosedElements in interface Element

Returns:

the top-level classes and interfaces within this package

See Also:

• TypeElement.getEnclosedElements()
• getEnclosedElements()
• ModuleElement.getEnclosedElements()
• Elements.getAllMembers(TypeElement)

isUnnamed

boolean isUnnamed()

Returns true if this is an unnamed package and false otherwise.

Returns:

true if this is an unnamed package and false otherwise

See Java Language Specification:

7.4.2 Unnamed Packages

getEnclosingElement

Element getEnclosingElement()

Returns the enclosing module if such a module exists; otherwise null. One situation where a module does not exist for a package is if the environment does not include modules, such as an annotation processing environment configured for a source version without modules.

Specified by:

getEnclosingElement in interface Element

Returns:

the enclosing module if such a module exists; otherwise null

See Also:

• Elements.getPackageOf(Element)