Package io.substrait.type

Class ImmutableType.Map

java.lang.Object
io.substrait.type.Type.Map
io.substrait.type.ImmutableType.Map
All Implemented Interfaces:
FunctionArg, NullableType, ParameterizedType, TypeExpression, Type
Enclosing class:
ImmutableType
public static final class ImmutableType.Map extends Type.Map
Immutable implementation of Type.Map.

Use the builder to create immutable instances: ImmutableType.Map.builder().

  • Method Details

    • nullable

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

    • key

      public Type key()
      Specified by:
      key in class Type.Map
      Returns:
      The value of the key attribute

    • value

      public Type value()
      Specified by:
      value in class Type.Map
      Returns:
      The value of the value attribute

    • withNullable

      public final ImmutableType.Map 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

    • withKey

      public final ImmutableType.Map withKey(Type value)
      Copy the current immutable object by setting a value for the key attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for key
      Returns:
      A modified copy or the this object

    • withValue

      public final ImmutableType.Map withValue(Type value)
      Copy the current immutable object by setting a value for the value attribute. A shallow reference equality check is 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 Map 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, key, value.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableType.Map copyOf(Type.Map instance)
      Creates an immutable copy of a Type.Map 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 Map instance

    • builder

      public static ImmutableType.Map.Builder builder()
      Creates a builder for Map. 
       ImmutableType.Map.builder()
    .nullable(boolean) // required nullable
    .key(io.substrait.type.Type) // required key
    .value(io.substrait.type.Type) // required value
    .build();
      Returns:
      A new Map builder