Record Class Field

java.lang.Object
java.lang.Record
dev.omnist.schema.Field
Record Components:
label - the field label; must not be null
type - the field type; must not be null
min - the minimum occurrence count; must be >= 0
max - the maximum occurrence count; null means unbounded; if non-null, must be >= min

public record Field(String label, Type type, int min, Integer max) extends Record
An immutable field declaration within a Record definition (omnist-spec ยง5.4).

A field captures:

  • a label โ€” the JSON/OML key name as a quoted string in OSD
  • a type โ€” a scalar type, a Type.Ref to another record, or Type.Any
  • cardinality bounds [min, max] โ€” minimum and maximum occurrence count per node; max == null means unbounded
The default cardinality when omitted in OSD is [1, 1] (exactly one occurrence).
  • Constructor Summary

    Constructors
    Constructor
    Description
    Field(String label, Type type, int min, Integer max)
    Compact constructor that enforces label/type non-null and cardinality invariants.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the label record component.
    max()
    Returns the value of the max record component.
    int
    min()
    Returns the value of the min record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

  • 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 '=='.
      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.
    • label

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

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

      public int min()
      Returns the value of the min record component.
      Returns:
      the value of the min record component
    • max

      public Integer max()
      Returns the value of the max record component.
      Returns:
      the value of the max record component