Package io.fluxzero.tools.jsondoclet.model

Record Class MethodDocumentation

java.lang.Object
java.lang.Record
io.fluxzero.tools.jsondoclet.model.MethodDocumentation
public record MethodDocumentation(String name, String qualifiedName, String returnType, List<String> modifiers, List<AnnotationDocumentation> annotations, List<String> typeParameters, List<MethodDocumentation.MethodParameter> parameters, List<String> thrownTypes, boolean varArgs, String documentation) extends Record
Documentation extracted for an individual method.

  • Constructor Details

    • MethodDocumentation

      public MethodDocumentation(String name, String qualifiedName, String returnType, List<String> modifiers, List<AnnotationDocumentation> annotations, List<String> typeParameters, List<MethodDocumentation.MethodParameter> parameters, List<String> thrownTypes, boolean varArgs, String documentation)
      Creates an instance of a MethodDocumentation record class.
      Parameters:
      name - the value for the name record component
      qualifiedName - the value for the qualifiedName record component
      returnType - the value for the returnType record component
      modifiers - the value for the modifiers record component
      annotations - the value for the annotations record component
      typeParameters - the value for the typeParameters record component
      parameters - the value for the parameters record component
      thrownTypes - the value for the thrownTypes record component
      varArgs - the value for the varArgs record component
      documentation - the value for the documentation 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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

    • returnType

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

    • typeParameters

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

    • parameters

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

    • thrownTypes

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

    • varArgs

      public boolean varArgs()
      Returns the value of the varArgs record component.
      Returns:
      the value of the varArgs record component

    • documentation

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