Package dev.rafex.ether.http.openapi.model

Record Class OpenApiSchema

java.lang.Object
java.lang.Record
dev.rafex.ether.http.openapi.model.OpenApiSchema
public record OpenApiSchema(String type, String format, String description, boolean nullable, Object example, String ref, Map<String,OpenApiSchema> properties, List<String> required, OpenApiSchema items) extends Record

  • Constructor Details

    • OpenApiSchema

      public OpenApiSchema(String type, String format, String description, boolean nullable, Object example, String ref, Map<String,OpenApiSchema> properties, List<String> required, OpenApiSchema items)
      Creates an instance of a OpenApiSchema record class.
      Parameters:
      type - the value for the type record component
      format - the value for the format record component
      description - the value for the description record component
      nullable - the value for the nullable record component
      example - the value for the example record component
      ref - the value for the ref record component
      properties - the value for the properties record component
      required - the value for the required record component
      items - the value for the items record component

  • Method Details

    • stringSchema

      public static OpenApiSchema stringSchema()

    • integerSchema

      public static OpenApiSchema integerSchema()

    • 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.

    • type

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

    • format

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

    • description

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

    • nullable

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

    • example

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

    • ref

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

    • properties

      public Map<String,OpenApiSchema> properties()
      Returns the value of the properties record component.
      Returns:
      the value of the properties record component

    • required

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

    • items

      public OpenApiSchema items()
      Returns the value of the items record component.
      Returns:
      the value of the items record component