Record Class ApiDocEndpoint

java.lang.Object
java.lang.Record
io.fluxzero.sdk.web.ApiDocEndpoint
public record ApiDocEndpoint(Class<?> handlerType, Executable executable, String origin, String path, String method, boolean autoHead, boolean autoOptions, ApiDocDetails documentation, List<ApiDocParameter> parameters, List<ApiDocRequestBody> requestBodies, Type responseType, List<ApiDocResponseDescriptor> responses) extends Record
Describes a single extracted web API endpoint.

  • Constructor Details

    • ApiDocEndpoint

      public ApiDocEndpoint(Class<?> handlerType, Executable executable, String origin, String path, String method, boolean autoHead, boolean autoOptions, ApiDocDetails documentation, List<ApiDocParameter> parameters, List<ApiDocRequestBody> requestBodies, Type responseType, List<ApiDocResponseDescriptor> responses)
      Creates an instance of a ApiDocEndpoint record class.
      Parameters:
      handlerType - the value for the handlerType record component
      executable - the value for the executable record component
      origin - the value for the origin record component
      path - the value for the path record component
      method - the value for the method record component
      autoHead - the value for the autoHead record component
      autoOptions - the value for the autoOptions record component
      documentation - the value for the documentation record component
      parameters - the value for the parameters record component
      requestBodies - the value for the requestBodies record component
      responseType - the value for the responseType record component
      responses - the value for the responses 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 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.

    • handlerType

      public Class<?> handlerType()
      Returns the value of the handlerType record component.
      Returns:
      the value of the handlerType record component

    • executable

      public Executable executable()
      Returns the value of the executable record component.
      Returns:
      the value of the executable record component

    • origin

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

    • path

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

    • method

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

    • autoHead

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

    • autoOptions

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

    • documentation

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

    • parameters

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

    • requestBodies

      public List<ApiDocRequestBody> requestBodies()
      Returns the value of the requestBodies record component.
      Returns:
      the value of the requestBodies record component

    • responseType

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

    • responses

      public List<ApiDocResponseDescriptor> responses()
      Returns the value of the responses record component.
      Returns:
      the value of the responses record component