Record Class KonceptDefinition.PatternField

java.lang.Object
java.lang.Record
network.ike.docs.koncept.KonceptDefinition.PatternField
Record Components:
meaning - the field's own meaning koncept identifier
purpose - the field's own purpose koncept identifier
dataType - the field's own data-type koncept identifier
example - this field's actual value on the same example semantic used for KonceptDefinition.referencedComponentExample() — a koncept identifier if the value resolves to one, otherwise its plain display text — or null if no example semantic was found
defaultValue - this field's value on the pattern's default value semantic (parsed from the default: YAML key — IKE-Network/ike-issues#888), with the same identifier-or-display-text convention as example — or null when the pattern has no active default value semantic
Enclosing class:
KonceptDefinition
public static record KonceptDefinition.PatternField(String meaning, String purpose, String dataType, String example, String defaultValue) extends Record
One field of a kind: pattern koncept: its own meaning, purpose, and data-type koncept identifiers, in the pattern's own declared field order.

  • Constructor Details

    • PatternField

      public PatternField(String meaning, String purpose, String dataType, String example, String defaultValue)
      Creates an instance of a PatternField record class.
      Parameters:
      meaning - the value for the meaning record component
      purpose - the value for the purpose record component
      dataType - the value for the dataType record component
      example - the value for the example record component
      defaultValue - the value for the defaultValue 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. 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.

    • meaning

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

    • purpose

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

    • dataType

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

    • example

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

    • defaultValue

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