Package io.substrait.function

Class ImmutableParameterizedType.StringLiteral

java.lang.Object
io.substrait.function.ParameterizedType.BaseParameterizedType
io.substrait.function.ParameterizedType.StringLiteral
io.substrait.function.ImmutableParameterizedType.StringLiteral
All Implemented Interfaces:
NullableType, ParameterizedType, TypeExpression
Enclosing class:
ImmutableParameterizedType
public static final class ImmutableParameterizedType.StringLiteral extends ParameterizedType.StringLiteral
Immutable implementation of ParameterizedType.StringLiteral.

Use the builder to create immutable instances: ImmutableParameterizedType.StringLiteral.builder().

  • Method Details

    • nullable

      public boolean nullable()
      Returns:
      The value of the nullable attribute

    • value

      public String value()
      Specified by:
      value in class ParameterizedType.StringLiteral
      Returns:
      The value of the value attribute

    • withNullable

      public final ImmutableParameterizedType.StringLiteral withNullable(boolean value)
      Copy the current immutable object by setting a value for the nullable attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for nullable
      Returns:
      A modified copy or the this object

    • withValue

      public final ImmutableParameterizedType.StringLiteral withValue(String value)
      Copy the current immutable object by setting a value for the value attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for value
      Returns:
      A modified copy or the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of StringLiteral that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: nullable, value.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value StringLiteral with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableParameterizedType.StringLiteral copyOf(ParameterizedType.StringLiteral instance)
      Creates an immutable copy of a ParameterizedType.StringLiteral value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable StringLiteral instance

    • builder

      public static ImmutableParameterizedType.StringLiteral.Builder builder()
      Creates a builder for StringLiteral. 
       ImmutableParameterizedType.StringLiteral.builder()
    .nullable(boolean) // required nullable
    .value(String) // required value
    .build();
      Returns:
      A new StringLiteral builder