Package io.fluxzero.tools.jsondoclet.model

Record Class TypeDocumentation

java.lang.Object
java.lang.Record
io.fluxzero.tools.jsondoclet.model.TypeDocumentation
public record TypeDocumentation(String name, String qualifiedName, String packageName, String kind, List<String> modifiers, List<AnnotationDocumentation> annotations, String documentation, List<String> typeParameters, String superClass, List<String> interfaces, List<FieldDocumentation> fields, List<ConstructorDocumentation> constructors, List<MethodDocumentation> methods, List<EnumConstantDocumentation> enumConstants, List<RecordComponentDocumentation> recordComponents, List<NestedTypeDocumentation> nestedTypes) extends Record
Aggregated documentation for a single declared type.

  • Constructor Details

    • TypeDocumentation

      public TypeDocumentation(String name, String qualifiedName, String packageName, String kind, List<String> modifiers, List<AnnotationDocumentation> annotations, String documentation, List<String> typeParameters, String superClass, List<String> interfaces, List<FieldDocumentation> fields, List<ConstructorDocumentation> constructors, List<MethodDocumentation> methods, List<EnumConstantDocumentation> enumConstants, List<RecordComponentDocumentation> recordComponents, List<NestedTypeDocumentation> nestedTypes)
      Creates an instance of a TypeDocumentation record class.
      Parameters:
      name - the value for the name record component
      qualifiedName - the value for the qualifiedName record component
      packageName - the value for the packageName record component
      kind - the value for the kind record component
      modifiers - the value for the modifiers record component
      annotations - the value for the annotations record component
      documentation - the value for the documentation record component
      typeParameters - the value for the typeParameters record component
      superClass - the value for the superClass record component
      interfaces - the value for the interfaces record component
      fields - the value for the fields record component
      constructors - the value for the constructors record component
      methods - the value for the methods record component
      enumConstants - the value for the enumConstants record component
      recordComponents - the value for the recordComponents record component
      nestedTypes - the value for the nestedTypes record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • qualifiedName

      public String qualifiedName()
      Returns the value of the qualifiedName record component.
      Returns:
      the value of the qualifiedName record component

    • packageName

      public String packageName()
      Returns the value of the packageName record component.
      Returns:
      the value of the packageName record component

    • kind

      public String kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • modifiers

      public List<String> modifiers()
      Returns the value of the modifiers record component.
      Returns:
      the value of the modifiers record component

    • annotations

      public List<AnnotationDocumentation> annotations()
      Returns the value of the annotations record component.
      Returns:
      the value of the annotations record component

    • documentation

      public String documentation()
      Returns the value of the documentation record component.
      Returns:
      the value of the documentation record component

    • typeParameters

      public List<String> typeParameters()
      Returns the value of the typeParameters record component.
      Returns:
      the value of the typeParameters record component

    • superClass

      public String superClass()
      Returns the value of the superClass record component.
      Returns:
      the value of the superClass record component

    • interfaces

      public List<String> interfaces()
      Returns the value of the interfaces record component.
      Returns:
      the value of the interfaces record component

    • fields

      public List<FieldDocumentation> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component

    • constructors

      public List<ConstructorDocumentation> constructors()
      Returns the value of the constructors record component.
      Returns:
      the value of the constructors record component

    • methods

      public List<MethodDocumentation> methods()
      Returns the value of the methods record component.
      Returns:
      the value of the methods record component

    • enumConstants

      public List<EnumConstantDocumentation> enumConstants()
      Returns the value of the enumConstants record component.
      Returns:
      the value of the enumConstants record component

    • recordComponents

      public List<RecordComponentDocumentation> recordComponents()
      Returns the value of the recordComponents record component.
      Returns:
      the value of the recordComponents record component

    • nestedTypes

      public List<NestedTypeDocumentation> nestedTypes()
      Returns the value of the nestedTypes record component.
      Returns:
      the value of the nestedTypes record component