Package io.substrait.type

Class ImmutableType.Struct

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

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

  • Method Details

    • nullable

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

    • fields

      public List<Type> fields()
      Specified by:
      fields in class Type.Struct
      Returns:
      The value of the fields attribute

    • withNullable

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

    • withFields

      public final ImmutableType.Struct withFields(Type... elements)
      Copy the current immutable object with elements that replace the content of fields.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withFields

      public final ImmutableType.Struct withFields(Iterable<? extends Type> elements)
      Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of fields elements to set
      Returns:
      A modified copy or this if not changed

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of Struct 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, fields.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableType.Struct.Builder builder()
      Creates a builder for Struct. 
       ImmutableType.Struct.builder()
    .nullable(boolean) // required nullable
    .addFields|addAllFields(io.substrait.type.Type) // fields elements
    .build();
      Returns:
      A new Struct builder