oracle.javatools.parser.java.v2.model

Interface JavaPackage

All Superinterfaces:

Element, JavaElement, JavaHasAnnotations, JavaHasName

All Known Implementing Classes:

AbstractPackage, BaseFileProvider.BasePackage, WrapperPackage

public interface JavaPackage
extends JavaElement, JavaHasName, JavaHasAnnotations

A JavaPackage is the compiled representation of a Java package.

Field Summary

Fields

Modifier and Type	Field and Description
static JavaPackage[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	exists() Checks if this package actually exists.
java.util.Collection<JavaClass>	getDeclaredClasses()
java.lang.String	getName()
JavaPackage	getOwningPackage()
JavaPackage	getPackage(java.lang.String name)
java.util.Collection<JavaPackage>	getPackages()
java.lang.String	getQualifiedName()
java.lang.String	getUniqueIdentifier() Gets a unique identifier for this element.

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasAnnotations

getAnnotation, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, hasAnnotation, hasDeclaredAnnotation

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaElement

getElementKind, getFile, getModifiers, getOwner, getSourceElement, isDeprecated, isFinal, isHidden, isSourceElement, isSynthetic, printCompiledInfo

Field Detail

EMPTY_ARRAY

static final JavaPackage[] EMPTY_ARRAY

Method Detail

getName

java.lang.String getName()

Specified by:

getName in interface JavaHasName

Returns:

The fully qualified package name in dotted notation, e.g. "javax.swing". Empty if the root package.

getQualifiedName

java.lang.String getQualifiedName()

Returns:

The fully qualified package in dotted notation, e.g. "javax.swing". Empty if the root package.

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Gets a unique identifier for this element. Two elements are equal iff their unique identifiers are equal.

Returns:

The unique identifier for this type.

getDeclaredClasses

java.util.Collection<JavaClass> getDeclaredClasses()

Returns:

The array of all top-level classes. Clients who want all classes within a package must recurse. Returns a collection of JavaClass's.

getOwningPackage

JavaPackage getOwningPackage()

Returns:

The owning package.

getPackage

JavaPackage getPackage(java.lang.String name)

Parameters:

name - If empty, this will return the package itself.

Returns:

The sub packages bearing the input name. Null if none.

getPackages

java.util.Collection<JavaPackage> getPackages()

Returns:

The array of sub packages to the current package.

exists

boolean exists()

Checks if this package actually exists.

Returns:

True if this package actually exists, false if this is a synthetic package