Interface PartialClassData

A partial ClassData.

interface PartialClassData {
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "class";
    fields: Collection<string, FieldData<null | ClassData | InterfaceData>>;
    id: string;
    methods: Collection<string, MethodData<null | ClassData | InterfaceData>>;
    modifiers: Modifier[];
    name: string;
    partialExtends: null | string | ExternalEntityData;
    partialImplements: (string | ExternalEntityData)[];
    partialPackage: PartialPackageData;
    qualifiedName: string;
    signature: string;
    typeParameters: Collection<string, ObjectTypeParameterData>;
    url: string;
}

Hierarchy

  • Omit<ClassData, "package" | "extends" | "implements">
    • PartialClassData

Properties

deprecation description entityType fields id methods modifiers name partialExtends partialImplements partialPackage qualifiedName signature typeParameters url

Properties

deprecation

deprecation: null | DeprecationContent

The class' deprecation notice, if any.

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

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "class"

The entity's type.

fields

fields: Collection<string, FieldData<null | ClassData | InterfaceData>>

The class' fields, keyed by their {@link FieldData#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.

methods

methods: Collection<string, MethodData<null | ClassData | InterfaceData>>

The class' methods, keyed by their MethodData#prototype.

modifiers

modifiers: Modifier[]

The class' modifiers.

name

name: string

The entity's name.

partialExtends

partialExtends: null | string | ExternalEntityData

Can be a class's fully qualified name, or an ExternalEntityData.

partialImplements

partialImplements: (string | ExternalEntityData)[]

Can be an interface's fully qualified name, or an ExternalEntityData.

partialPackage

partialPackage: PartialPackageData

qualifiedName

qualifiedName: string

The fully qualified name of the class (eg. java.lang.String).

signature

signature: string

The entity's signature.

typeParameters

typeParameters: Collection<string, ObjectTypeParameterData>

The class' type parameters, keyed by their ObjectTypeParameterData#name.

url

url: string

The class's Javadocs URL.

Settings

Member Visibility

On This Page

Properties