Class Javadocs

Holds the result of a scraped Javadocs.

Index

Constructors

Properties

annotations classes enums interfaces packages

Accessors

Methods

getAnnotation getAnnotations getClass getClasses getEnum getEnums getInterface getInterfaces getPackage getPackages

Constructors

constructor

new Javadocs(
    data: {
        annotations: Map<string, AnnotationData>;
        classes: Map<string, ClassData>;
        enums: Map<string, EnumData>;
        interfaces: Map<string, InterfaceData>;
        packages: Map<string, PackageData>;
    },
): Javadocs
Parameters
- data: {
      annotations: Map<string, AnnotationData>;
      classes: Map<string, ClassData>;
      enums: Map<string, EnumData>;
      interfaces: Map<string, InterfaceData>;
      packages: Map<string, PackageData>;
  }
Returns Javadocs
- Defined in javadocs/Javadocs.ts:19

Properties

`Protected` `Readonly`annotations

annotations: Map<string, AnnotationData>

`Protected` `Readonly`classes

classes: Map<string, ClassData>

`Protected` `Readonly`enums

enums: Map<string, EnumData>

`Protected` `Readonly`interfaces

interfaces: Map<string, InterfaceData>

`Protected` `Readonly`packages

packages: Map<string, PackageData>

Accessors

size

get size(): number
Returns number
- Defined in javadocs/Javadocs.ts:33

Methods

getAnnotation

getAnnotation(qualifiedName: string): null | AnnotationData
Returns an annotation by its AnnotationData#qualifiedName.
Parameters
- qualifiedName: string
Returns null | AnnotationData
- Defined in javadocs/Javadocs.ts:64

getAnnotations

getAnnotations(): Map<string, AnnotationData>
Returns all the annotations in the Javadocs.

Returns Map<string, AnnotationData>
- Defined in javadocs/Javadocs.ts:89

getClass

getClass(qualifiedName: string): null | ClassData
Returns a class by its ClassData#qualifiedName.
Parameters
- qualifiedName: string
Returns null | ClassData
- Defined in javadocs/Javadocs.ts:44

getClasses

getClasses(): Map<string, ClassData>
Returns all the classes in the Javadocs.

Returns Map<string, ClassData>
- Defined in javadocs/Javadocs.ts:69

getEnum

getEnum(qualifiedName: string): null | EnumData
Returns an enum by its EnumData#qualifiedName.
Parameters
- qualifiedName: string
Returns null | EnumData
- Defined in javadocs/Javadocs.ts:54

getEnums

getEnums(): Map<string, EnumData>
Returns all the enums in the Javadocs.

Returns Map<string, EnumData>
- Defined in javadocs/Javadocs.ts:79

getInterface

getInterface(qualifiedName: string): null | InterfaceData
Returns an interface by its InterfaceData#qualifiedName.
Parameters
- qualifiedName: string
Returns null | InterfaceData
- Defined in javadocs/Javadocs.ts:59

getInterfaces

getInterfaces(): Map<string, InterfaceData>
Returns all the interfaces in the Javadocs.

Returns Map<string, InterfaceData>
- Defined in javadocs/Javadocs.ts:84

getPackage

getPackage(name: string): null | PackageData
Returns a package by its PackageData#name.
Parameters
- name: string
Returns null | PackageData
- Defined in javadocs/Javadocs.ts:49

getPackages

getPackages(): Map<string, PackageData>
Returns all the packages in the Javadocs.

Returns Map<string, PackageData>
- Defined in javadocs/Javadocs.ts:74