Interface InterfaceData

Data for a Java interface.

interface InterfaceData {
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "interface";
    extends: Collection<string, ExternalEntityData | InterfaceData>;
    fields: Collection<string, FieldData<null | InterfaceData>>;
    id: string;
    methods: Collection<string, MethodData<null | InterfaceData>>;
    name: string;
    package: PackageData;
    qualifiedName: string;
    signature: string;
    typeParameters: Collection<string, ObjectTypeParameterData>;
    url: string;
}

Hierarchy (View Summary)

Properties

deprecation description entityType extends fields id methods name package qualifiedName signature typeParameters url

Properties

deprecation

deprecation: null | DeprecationContent

The interface's deprecation notice, if any.

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

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "interface"

The entity's type.

extends

extends: Collection<string, ExternalEntityData | InterfaceData>

The interfaces that this interface extends, keyed by their InterfaceData#qualifiedName (or ExternalEntityData#qualifiedName).

fields

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

The interface' fields, keyed by their FieldData#name.

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 | InterfaceData>>

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

name

name: string

The entity's name.

package

package: PackageData

The package that the interface is in.

qualifiedName

qualifiedName: string

The fully qualified name of the interface (eg. java.lang.Iterable).

signature

signature: string

The entity's signature.

typeParameters

typeParameters: Collection<string, ObjectTypeParameterData>

url

url: string

The interface's Javadocs URL.

Settings

Member Visibility

On This Page

Properties