Type Alias CommonEntityData<Type>

CommonEntityData: {
    description: NodeContent | null;
    entityType: Type;
    id: string;
    name: string;
    signature: string;
}

Common data for every supported Java entity.

Type Parameters

Type extends EntityType

Type declaration

description: NodeContent | null
The entity's description, if any.
entityType: Type
The entity's type.
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, annotation elements, method type parameters, object type parameters and parameters: the name.
- In methods: the prototype, to avoid conflicts with overloaded methods.
name: string
The entity's name.
signature: string
The entity's signature.