Interface PackageDescription

All Superinterfaces:

AnnotationSource, NamedElement, NamedElement.WithRuntimeName

All Known Implementing Classes:

PackageDescription.AbstractBase, PackageDescription.ForLoadedPackage, PackageDescription.Simple, TypePool.Default.LazyTypeDescription.LazyPackageDescription

public interface PackageDescription
extends NamedElement.WithRuntimeName, AnnotationSource

A package description represents a Java package.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PackageDescription.AbstractBase	An abstract base implementation of a package description.
static class	PackageDescription.ForLoadedPackage	Represents a loaded Package wrapped as a PackageDescription.
static class	PackageDescription.Simple	A simple implementation of a package without annotations.

Nested classes/interfaces inherited from interface AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

Nested classes/interfaces inherited from interface NamedElement

NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

Field Summary

Fields

Modifier and Type	Field	Description
static final PackageDescription	DEFAULT	A representation of the default package without any annotations.
static final String	PACKAGE_CLASS_NAME	The name of a Java class representing a package description.
static final int	PACKAGE_MODIFIERS	The modifiers of a Java class representing a package description.
static final PackageDescription	UNDEFINED	A named constant for an undefined package what applies for primitive and array types.

Fields inherited from interface NamedElement

EMPTY_NAME, NO_NAME

Method Summary

Modifier and Type	Method	Description
boolean	contains(TypeDescription typeDescription)	Checks if this package contains the provided type.
boolean	isDefault()	Returns true if this package description represents the default package.

Methods inherited from interface AnnotationSource

getDeclaredAnnotations

Methods inherited from interface NamedElement

getActualName

Methods inherited from interface NamedElement.WithRuntimeName

getInternalName, getName

Field Details

DEFAULT

static final PackageDescription DEFAULT

A representation of the default package without any annotations.

PACKAGE_CLASS_NAME

static final String PACKAGE_CLASS_NAME

The name of a Java class representing a package description.

See Also:

• Constant Field Values

PACKAGE_MODIFIERS

static final int PACKAGE_MODIFIERS

The modifiers of a Java class representing a package description.

See Also:

• Constant Field Values

UNDEFINED

@AlwaysNull
static final PackageDescription UNDEFINED

A named constant for an undefined package what applies for primitive and array types.

Method Details

contains

boolean contains(TypeDescription typeDescription)

Checks if this package contains the provided type.

Parameters:

typeDescription - The type to examine.

Returns:

true if the given type contains the provided type.

isDefault

boolean isDefault()

Returns true if this package description represents the default package.

Returns:

true if this package description represents the default package.