Record Class ApiDocRequestBody

java.lang.Object
java.lang.Record
io.fluxzero.sdk.web.ApiDocRequestBody
public record ApiDocRequestBody(Type type, Parameter parameter) extends Record
Describes a full request body parameter inferred from an unannotated web handler argument.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ApiDocRequestBody(Type type, Parameter parameter)
    Creates an instance of a ApiDocRequestBody record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Parameter
    parameter()
    Returns the value of the parameter record component.
    final String
    toString()
    Returns a string representation of this record class.
    Type
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ApiDocRequestBody

      public ApiDocRequestBody(Type type, Parameter parameter)
      Creates an instance of a ApiDocRequestBody record class.
      Parameters:
      type - the value for the type record component
      parameter - the value for the parameter 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.

    • type

      public Type type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • parameter

      public Parameter parameter()
      Returns the value of the parameter record component.
      Returns:
      the value of the parameter record component