Package io.substrait.expression

Class ImmutableExpression.IntervalYearLiteral

java.lang.Object

io.substrait.expression.Expression.IntervalYearLiteral

io.substrait.expression.ImmutableExpression.IntervalYearLiteral

All Implemented Interfaces:

Expression, Expression.Literal, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.IntervalYearLiteral
extends Expression.IntervalYearLiteral

Immutable implementation of Expression.IntervalYearLiteral.

Use the builder to create immutable instances: ImmutableExpression.IntervalYearLiteral.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableExpression.IntervalYearLiteral.Builder	Builds instances of type IntervalYearLiteral.

Nested classes/interfaces inherited from interface io.substrait.expression.Expression

Expression.AggregationInvocation, Expression.AggregationPhase, Expression.BinaryLiteral, Expression.BoolLiteral, Expression.Cast, Expression.DateLiteral, Expression.DecimalLiteral, Expression.EmptyListLiteral, Expression.EmptyMapLiteral, Expression.FailureBehavior, Expression.FixedBinaryLiteral, Expression.FixedCharLiteral, Expression.FP32Literal, Expression.FP64Literal, Expression.I16Literal, Expression.I32Literal, Expression.I64Literal, Expression.I8Literal, Expression.IfClause, Expression.IfThen, Expression.InPredicate, Expression.IntervalCompoundLiteral, Expression.IntervalDayLiteral, Expression.IntervalYearLiteral, Expression.Lambda, Expression.ListLiteral, Expression.Literal, Expression.MapLiteral, Expression.MultiOrList, Expression.MultiOrListRecord, Expression.Nested, Expression.NestedList, Expression.NestedStruct, Expression.NullLiteral, Expression.PrecisionTimeLiteral, Expression.PrecisionTimestampLiteral, Expression.PrecisionTimestampTZLiteral, Expression.PredicateOp, Expression.ScalarFunctionInvocation, Expression.ScalarSubquery, Expression.SetPredicate, Expression.SingleOrList, Expression.SortDirection, Expression.SortField, Expression.StrLiteral, Expression.StructLiteral, Expression.Subquery, Expression.Switch, Expression.SwitchClause, Expression.TimeLiteral, Expression.TimestampLiteral, Expression.TimestampTZLiteral, Expression.UserDefinedAnyLiteral, Expression.UserDefinedLiteral, Expression.UserDefinedStructLiteral, Expression.UUIDLiteral, Expression.VarCharLiteral, Expression.WindowBoundsType, Expression.WindowFunctionInvocation

Nested classes/interfaces inherited from interface io.substrait.expression.FunctionArg

FunctionArg.FuncArgVisitor<R,C extends VisitationContext,E extends Throwable>, FunctionArg.ProtoFrom

Method Summary

Modifier and Type	Method	Description
static ImmutableExpression.IntervalYearLiteral.Builder	builder()	Creates a builder for IntervalYearLiteral.
static ImmutableExpression.IntervalYearLiteral	copyOf(Expression.IntervalYearLiteral instance)	Creates an immutable copy of a Expression.IntervalYearLiteral value.
boolean	equals(Object another)	This instance is equal to all instances of IntervalYearLiteral that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: nullable, years, months.
int	months()
boolean	nullable()
String	toString()	Prints the immutable value IntervalYearLiteral with attribute values.
final ImmutableExpression.IntervalYearLiteral	withMonths(int value)	Copy the current immutable object by setting a value for the months attribute.
final ImmutableExpression.IntervalYearLiteral	withNullable(boolean value)	Copy the current immutable object by setting a value for the nullable attribute.
final ImmutableExpression.IntervalYearLiteral	withYears(int value)	Copy the current immutable object by setting a value for the years attribute.
int	years()

Methods inherited from class io.substrait.expression.Expression.IntervalYearLiteral

accept, getType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.substrait.expression.Expression

accept

Method Details

nullable

public boolean nullable()

Returns:

The value of the nullable attribute

years

public int years()

Specified by:

years in class Expression.IntervalYearLiteral

Returns:

The value of the years attribute

months

public int months()

Specified by:

months in class Expression.IntervalYearLiteral

Returns:

The value of the months attribute

withNullable

public final ImmutableExpression.IntervalYearLiteral 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

withYears

public final ImmutableExpression.IntervalYearLiteral withYears(int value)

Copy the current immutable object by setting a value for the years attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for years

Returns:

A modified copy or the this object

withMonths

public final ImmutableExpression.IntervalYearLiteral withMonths(int value)

Copy the current immutable object by setting a value for the months attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for months

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of IntervalYearLiteral 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, years, months.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value IntervalYearLiteral with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableExpression.IntervalYearLiteral copyOf(Expression.IntervalYearLiteral instance)

Creates an immutable copy of a Expression.IntervalYearLiteral 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 IntervalYearLiteral instance

builder

public static ImmutableExpression.IntervalYearLiteral.Builder builder()

Creates a builder for IntervalYearLiteral.

 ImmutableExpression.IntervalYearLiteral.builder()
    .nullable(boolean) // optional nullable
    .years(int) // required years
    .months(int) // required months
    .build();
 

Returns:

A new IntervalYearLiteral builder