Interface EnumConstantData

Data for a Java enum constant, inside EnumData#constants.

interface EnumConstantData {
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "enumConstant";
    id: string;
    name: string;
    ordinal: number;
    signature: string;
    url: string;
}

Hierarchy (View Summary)

CommonEntityData<typeof EnumConstant>
- EnumConstantData

Index

Properties

deprecation description entityType id name ordinal signature url

Properties

deprecation

deprecation: null | DeprecationContent

The enum constant's deprecation notice, if any.

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "enumConstant"

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.

ordinal

ordinal: number

The enum constant's ordinal.

signature

signature: string

The entity's signature.

url

url: string

The enum constant's Javadocs URL.