Package io.substrait.function

Class ImmutableParameterizedType.Decimal

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

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

  • Method Details

    • nullable

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

    • scale

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

    • precision

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

    • withNullable

      public final ImmutableParameterizedType.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 ImmutableParameterizedType.Decimal withScale(ParameterizedType.StringLiteral value)
      Copy the current immutable object by setting a value for the scale attribute. A shallow reference 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 ImmutableParameterizedType.Decimal withPrecision(ParameterizedType.StringLiteral value)
      Copy the current immutable object by setting a value for the precision attribute. A shallow reference 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 ImmutableParameterizedType.Decimal copyOf(ParameterizedType.Decimal instance)
      Creates an immutable copy of a ParameterizedType.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 ImmutableParameterizedType.Decimal.Builder builder()
      Creates a builder for Decimal. 
       ImmutableParameterizedType.Decimal.builder()
    .nullable(boolean) // required nullable
    .scale(io.substrait.function.ParameterizedType.StringLiteral) // required scale
    .precision(io.substrait.function.ParameterizedType.StringLiteral) // required precision
    .build();
      Returns:
      A new Decimal builder