Record Class ApiDocResponseDescriptor

java.lang.Object
java.lang.Record
io.fluxzero.sdk.web.ApiDocResponseDescriptor
public record ApiDocResponseDescriptor(int status, String description, String ref, Type type, Type modelGraph, List<String> modelGraphPaths, String contentType) extends Record
Describes an explicitly documented API response.

  • Constructor Details

    • ApiDocResponseDescriptor

      public ApiDocResponseDescriptor(int status, String description, String ref, Type type, Type modelGraph, List<String> modelGraphPaths, String contentType)
      Creates an instance of a ApiDocResponseDescriptor record class.
      Parameters:
      status - the value for the status record component
      description - the value for the description record component
      ref - the value for the ref record component
      type - the value for the type record component
      modelGraph - the value for the modelGraph record component
      modelGraphPaths - the value for the modelGraphPaths record component
      contentType - the value for the contentType record component

    • ApiDocResponseDescriptor

      public ApiDocResponseDescriptor(int status, String description, String ref, Type type, String contentType)
      Creates a regular typed response descriptor without a model-graph schema.

    • ApiDocResponseDescriptor

      public ApiDocResponseDescriptor(int status, String description, String ref, Type type, Type modelGraph, String contentType)
      Creates a response descriptor without an explicit model-graph path selection.

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • status

      public int status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • description

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

    • ref

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

    • type

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

    • modelGraph

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

    • modelGraphPaths

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

    • contentType

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