Interface PackageData

Data for a Java package.

interface PackageData {
    annotations: Collection<string, AnnotationData>;
    classes: Collection<string, ClassData>;
    description: null | NodeContent;
    entityType: "package";
    enums: Collection<string, EnumData>;
    id: string;
    interfaces: Collection<string, InterfaceData>;
    name: string;
    relatedPackages: Collection<string, PackageData>;
    signature: string;
    subpackageName: string;
    url: string;
}

Hierarchy (View Summary)

Properties

annotations classes description entityType enums id interfaces name relatedPackages signature subpackageName url

Properties

annotations

annotations: Collection<string, AnnotationData>

The package's annotations, keyed by their AnnotationData#qualifiedName.

classes

classes: Collection<string, ClassData>

The package's classes, keyed by their ClassData#qualifiedName.

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "package"

The entity's type.

enums

enums: Collection<string, EnumData>

The package's enums, keyed by their EnumData#qualifiedName.

id

id: string

The entity's unique id (relative to others in the same context). Used as key in collections.

Specifically:

  • In classes, enums, interfaces, external objects and annotations: the qualifiedName.
  • In packages, enum constants, fields, method type parameters, object type parameters and parameters: the name.
  • In methods: the prototype, to avoid conflicts with overloaded methods.

interfaces

interfaces: Collection<string, InterfaceData>

The package's interfaces, keyed by their InterfaceData#qualifiedName.

name

name: string

The entity's name.

relatedPackages

relatedPackages: Collection<string, PackageData>

The package's related packages.

signature

signature: string

The entity's signature.

subpackageName

subpackageName: string

The package's subpackage name, (eg concurrent in java.util.concurrent).

url

url: string

The package's Javadocs URL.

Settings

Member Visibility

On This Page

Properties