Record Class Schema.SchemaDiscriminator

java.lang.Object
java.lang.Record
io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
Record Components:
propertyName - The discriminator property name
mapping - The mapping between property value and Java schemas, where the map value is a JSON Schema reference
Enclosing class:
Schema
public static record Schema.SchemaDiscriminator(String propertyName, Map<String,String> mapping) extends Record
Discriminator defines a property that can be used to distinguish between schemas that are defined as subtypes in code. It is not a standard JSON schema annotation, but is commonly used because it is defined in OpenAPI.
See Also:

  • Constructor Details

    • SchemaDiscriminator

      public SchemaDiscriminator(String propertyName, Map<String,String> mapping)
      Creates an instance of a SchemaDiscriminator record class.
      Parameters:
      propertyName - the value for the propertyName record component
      mapping - the value for the mapping record component

  • Method Details

    • merge

      public Schema.SchemaDiscriminator merge(Schema.SchemaDiscriminator other)

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

    • propertyName

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

    • mapping

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