Interface MethodData<Inheritable>

Data for a Java method.

interface MethodData<Inheritable extends ClassData | InterfaceData | null> {
    accessModifier: AccessModifier;
    annotations: string[];
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "method";
    id: string;
    inheritedFrom: Inheritable;
    modifiers: Modifier[];
    name: string;
    parameters: Collection<string, ParameterData>;
    prototype: string;
    returns: MethodReturnData;
    signature: string;
    typeParameters: Collection<string, MethodTypeParameterData>;
    url: string;
}

Type Parameters

Hierarchy (View Summary)

Properties

accessModifier: AccessModifier

The method's access modifier.

annotations: string[]

The method's applied annotations.

deprecation: null | DeprecationContent

The method' deprecation notice, if any.

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

description: null | NodeContent

The entity's description, if any.

entityType: "method"

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, method type parameters, object type parameters and parameters: the name.
  • In methods: the prototype, to avoid conflicts with overloaded methods.
inheritedFrom: Inheritable

The parent from where this method was inherited, if any.

modifiers: Modifier[]

The method's modifiers.

name: string

The entity's name.

parameters: Collection<string, ParameterData>

The method's parameters, keyed by their ParameterData#name.

prototype: string

The method's prototype (eg. indexOf(java.lang.String, int)).

The method's return type.

signature: string

The entity's signature.

typeParameters: Collection<string, MethodTypeParameterData>

The method's type parameters, keyed by their MethodTypeParameterData#name.

url: string

The method's Javadocs URL.