javax.lang.model.element

Interface PackageElement

All Superinterfaces:

AnnotatedConstruct, Element, QualifiedNameable

All Known Implementing Classes:

Symbol.PackageSymbol

public interface PackageElement
extends Element, QualifiedNameable

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

Since:

1.6

Author:

Joseph D. Darcy, Scott Seligman, Peter von der Ahé

See Also:

Elements.getPackageOf(javax.lang.model.element.Element)

Method Summary

Modifier and Type	Method and Description
List<? extends Element>	getEnclosedElements() Returns the top-level classes and interfaces within this package.
Element	getEnclosingElement() Returns null since a package is not enclosed by another element.
Name	getQualifiedName() Returns the fully qualified name of this package.
Name	getSimpleName() Returns the simple name of this package.
boolean	isUnnamed() Returns true is this is an unnamed package and false otherwise.

Methods inherited from interface javax.lang.model.element.Element

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

Methods inherited from interface javax.lang.model.AnnotatedConstruct

getAnnotationsByType

Method Detail

getQualifiedName

Name getQualifiedName()

Returns the fully qualified name of this package. This is also known as the package's canonical name.

Specified by:

getQualifiedName in interface QualifiedNameable

Returns:

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

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()

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:

getEnclosedElements(), TypeElement.getEnclosedElements(), Elements.getAllMembers(javax.lang.model.element.TypeElement)

isUnnamed

boolean isUnnamed()

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

Returns:

true is this is an unnamed package and false otherwise

getEnclosingElement

Element getEnclosingElement()

Returns null since a package is not enclosed by another element.

Specified by:

getEnclosingElement in interface Element

Returns:

null

See Also:

Elements.getPackageOf(javax.lang.model.element.Element)