Package io.fluxzero.tools.jsondoclet.model

Record Class FieldDocumentation

java.lang.Object
java.lang.Record
io.fluxzero.tools.jsondoclet.model.FieldDocumentation
public record FieldDocumentation(String name, String qualifiedName, String type, List<String> modifiers, List<AnnotationDocumentation> annotations, String documentation, Object constantValue) extends Record
Documentation for a field declaration.

  • Constructor Details

    • FieldDocumentation

      public FieldDocumentation(String name, String qualifiedName, String type, List<String> modifiers, List<AnnotationDocumentation> annotations, String documentation, Object constantValue)
      Creates an instance of a FieldDocumentation record class.
      Parameters:
      name - the value for the name record component
      qualifiedName - the value for the qualifiedName record component
      type - the value for the type 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
      constantValue - the value for the constantValue 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

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type 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

    • constantValue

      public Object constantValue()
      Returns the value of the constantValue record component.
      Returns:
      the value of the constantValue record component