Record Class CATypeScalarType.Text

java.lang.Object
java.lang.Record
com.io7m.cardant.model.CATypeScalarType.Text
Record Components:
name - The type name
description - A humanly-readable description of the type
pattern - The pattern that constrains text values
All Implemented Interfaces:
CATypeScalarType
Enclosing interface:
CATypeScalarType
public static record CATypeScalarType.Text(CATypeScalarIdentifier name, String description, String pattern) extends Record implements CATypeScalarType
A text type.

  • Constructor Details

    • Text

      public Text(CATypeScalarIdentifier name, String description, String pattern)
      A text type.
      Parameters:
      name - The type name
      description - A humanly-readable description of the type
      pattern - The pattern that constrains text values

  • Method Details

    • kind

      public CATypeScalarType.Kind kind()
      Specified by:
      kind in interface CATypeScalarType
      Returns:
      The internal type kind

    • withName

      public CATypeScalarType withName(CATypeScalarIdentifier newName)
      Specified by:
      withName in interface CATypeScalarType
      Parameters:
      newName - The new name
      Returns:
      This type with a new name

    • showConstraint

      public String showConstraint()
      Specified by:
      showConstraint in interface CATypeScalarType
      Returns:
      A humanly-readable description of this type's value constraints

    • isValid

      public boolean isValid(String value)
      Parameters:
      value - The value
      Returns:
      true if the given value is in the range for this type

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

    • name

      public CATypeScalarIdentifier name()
      Returns the value of the name record component.
      Specified by:
      name in interface CATypeScalarType
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Specified by:
      description in interface CATypeScalarType
      Returns:
      the value of the description record component

    • pattern

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