Skip to content
IrisIris

Record Class Value.StringValue

Javadoc 27 generates this reference during each site build from the exported packages and the annotation processor. The Java guide shows the API in use.

java.lang.Object
java.lang.Record
dev.gecode.iris.Value.StringValue
Record Components:
value - the string
All Implemented Interfaces:
Value
Enclosing interface:
Value
public static record Value.StringValue(String value) extends Record implements Value
A single string.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface Value

    Value.ArrayValue, Value.FloatValue, Value.IntValue, Value.StringValue
    Modifier and Type
    Interface
    Description
    static final class 
    Value.ArrayValue
    An array, or a row of a larger array, whose elements stay in place until they are asked for.
    static final record 
    Value.FloatValue
    A single float.
    static final record 
    Value.IntValue
    A single integer.
    static final record 
    Value.StringValue
    A single string.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StringValue(String value)
    Creates an instance of a StringValue record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asString()
    Returns this single string.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    ValueType
    type()
    Returns the type of the leaves.
    String
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface Value

    asDouble, asLong, at, depth, doubles, get, ints, longs, size, strings
    Modifier and Type
    Method
    Description
    default double
    asDouble()
    Returns this single number, as a float if it is an integer.
    default long
    asLong()
    Returns this single integer.
    default Value
    at(int... path)
    Follows indices into this value.
    default int
    depth()
    Returns the depth: 0 for a single value, and otherwise the levels of nesting.
    default double[]
    doubles()
    Returns a copy of the numbers of this one-dimensional array, integers as floats.
    default Value
    get(int index)
    Gets an element of this array.
    default int[]
    ints()
    Narrows the integers of this one-dimensional array.
    default long[]
    longs()
    Returns a copy of the integers of this one-dimensional array.
    default int
    size()
    Returns the number of elements of this array.
    default List<String>
    strings()
    Returns the strings of this one-dimensional array, as an unmodifiable list.

  • Constructor Details

    • StringValue

      public StringValue(String value)
      Creates an instance of a StringValue record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • type

      public ValueType type()
      Description copied from interface: Value
      Returns the type of the leaves.
      Specified by:
      type in interface Value
      Returns:
      the type of the leaves

    • asString

      public String asString()
      Description copied from interface: Value
      Returns this single string.
      Specified by:
      asString in interface Value
      Returns:
      this single string

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

    • value

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