Package io.substrait.type

Class ImmutableType.Decimal

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

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

  • Method Details

    • nullable

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

    • scale

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

    • precision

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

    • withNullable

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

    • withScale

      public final ImmutableType.Decimal withScale(int value)
      Copy the current immutable object by setting a value for the scale attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for scale
      Returns:
      A modified copy or the this object

    • withPrecision

      public final ImmutableType.Decimal withPrecision(int value)
      Copy the current immutable object by setting a value for the precision attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for precision
      Returns:
      A modified copy or the this object

    • equals

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

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableType.Decimal.Builder builder()
      Creates a builder for Decimal. 
       ImmutableType.Decimal.builder()
    .nullable(boolean) // required nullable
    .scale(int) // required scale
    .precision(int) // required precision
    .build();
      Returns:
      A new Decimal builder