OpenJDK 1.23 · javax.lang.model.element.PackageElement

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

Method Summary

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

Inherited from javax.lang.model.element.Element:: accept equals getAnnotation getAnnotationMirrors getAnnotationsByType getKind getModifiers hashCode

Method Detail

asType back to summary

asType	back to summary
public TypeMirror asType() Redeclares javax.lang.model.element.Element.asType. Returns a pseudo-type for this package. Returns:TypeMirror a pseudo-type for this package Annotations @Override See Also `javax.lang.model.type.NoType`, `javax.lang.model.type.TypeKind#PACKAGE`

public TypeMirror asType()

Redeclares javax.lang.model.element.Element.asType.

Returns a pseudo-type for this package.

Returns:TypeMirror

a pseudo-type for this package

Annotations

@Override

getEnclosedElements	back to summary
public List<? extends Element> getEnclosedElements() Redeclares javax.lang.model.element.Element.getEnclosedElements. Returns the top-level classes and interfaces within this package. Note that subpackages are not considered to be enclosed by a package. Returns:List<? extends Element> the top-level classes and interfaces within this package Annotations @Override

getEnclosedElements

back to summary

public List<? extends Element> getEnclosedElements()

Redeclares javax.lang.model.element.Element.getEnclosedElements.

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

Returns:List<? extends Element>

the top-level classes and interfaces within this package

Annotations

@Override

getEnclosingElement back to summary

getEnclosingElement	back to summary
public Element getEnclosingElement() Redeclares javax.lang.model.element.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. Returns:Element the enclosing module if such a module exists; otherwise `null` Annotations @Override

public Element getEnclosingElement()

Redeclares javax.lang.model.element.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.

Returns:Element

the enclosing module if such a module exists; otherwise null

Annotations

@Override

getQualifiedName back to summary

getQualifiedName	back to summary
public Name getQualifiedName() Redeclares javax.lang.model.element.QualifiedNameable.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. 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:Name the fully qualified name of this package, or an empty name if this is an unnamed package Java Language Specification 6.7 Fully Qualified Names and Canonical Names

public Name getQualifiedName()

Redeclares javax.lang.model.element.QualifiedNameable.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.

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:Name: the fully qualified name of this package, or an empty name if this is an unnamed package
Java Language Specification: 6.7 Fully Qualified Names and Canonical Names

getSimpleName	back to summary
public Name getSimpleName() Redeclares javax.lang.model.element.Element.getSimpleName. Returns the simple name of this package. For an unnamed package, an empty name is returned. Returns:Name the simple name of this package or an empty name if this is an unnamed package Annotations @Override

getSimpleName

back to summary

public Name getSimpleName()

Redeclares javax.lang.model.element.Element.getSimpleName.

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

Returns:Name

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

Annotations

@Override

isUnnamed back to summary

isUnnamed	back to summary
public boolean isUnnamed() Returns `true` if this is an unnamed package and `false` otherwise. Returns:boolean `true` if this is an unnamed package and `false` otherwise Java Language Specification 7.4.2 Unnamed Packages

public boolean isUnnamed()

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

Returns:boolean: true if this is an unnamed package and false otherwise
Java Language Specification: 7.4.2 Unnamed Packages

public Interface PackageElement

Method Summary

Method Detail