Interface AnnotationElementData

Common data for every supported Java entity.

interface AnnotationElementData {
    annotations: string[];
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "annotationElement";
    id: string;
    modifiers: Modifier[];
    name: string;
    returns: MethodReturnData;
    signature: string;
    url: string;
}

Hierarchy (View Summary)

Properties

annotations deprecation description entityType id modifiers name returns signature url

Properties

annotations

annotations: string[]

The element's applied annotations.

deprecation

deprecation: null | DeprecationContent

The element' deprecation notice, if any.

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

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "annotationElement"

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.

modifiers

modifiers: Modifier[]

The element's modifiers.

name

name: string

The entity's name.

returns

returns: MethodReturnData

The element's return type.

signature

signature: string

The entity's signature.

url

url: string

The element's Javadocs URL.

Settings

Member Visibility

On This Page

Properties