Interface AnnotationData

Data for a Java annotation interface.

interface AnnotationData {
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    elements: Collection<string, AnnotationElementData>;
    entityType: "annotationInterface";
    id: string;
    name: string;
    package: PackageData;
    qualifiedName: string;
    retention: null | RetentionPolicy;
    signature: string;
    target: null | ElementType;
    targets: ElementType[];
    url: string;
}

Hierarchy (View Summary)

Properties

deprecation description elements entityType id name package qualifiedName retention signature target targets url

Properties

deprecation

deprecation: null | DeprecationContent

The annotation's deprecation notice, if any.

This property is always present if the annotation is deprecated, regardless of whether it the notice any description or not.

description

description: null | NodeContent

The entity's description, if any.

elements

elements: Collection<string, AnnotationElementData>

The annotation's elements, keyed by their AnnotationElementData#name.

entityType

entityType: "annotationInterface"

The entity's type.

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.

name

name: string

The entity's name.

package

package: PackageData

The package that the annotation is in.

qualifiedName

qualifiedName: string

The fully qualified name of the annotation (eg. java.lang.annotation.Retention).

retention

retention: null | RetentionPolicy

The annotation's retention policy, if specified.

Even though this defaults to RetentionPolicyEnum.Class in Java runtime, given this library only scrapes Javadocs then if it isn't present it'll be set as null

signature

signature: string

The entity's signature.

target

target: null | ElementType

The annotation's element type target, if there's only one.

Deprecated

Use targets instead.

targets

targets: ElementType[]

The annotation's element type targets.

url

url: string

The annotation's Javadocs URL.

Settings

Member Visibility

On This Page

Properties