Package io.substrait.expression

Class ImmutableExpression.VarCharLiteral

java.lang.Object

io.substrait.expression.Expression.VarCharLiteral

io.substrait.expression.ImmutableExpression.VarCharLiteral

All Implemented Interfaces:

Expression, Expression.Literal, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.VarCharLiteral
extends Expression.VarCharLiteral

Immutable implementation of Expression.VarCharLiteral.

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

Nested Class Summary

Nested Classes

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

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.VarCharLiteral.Builder	builder()	Creates a builder for VarCharLiteral.
static ImmutableExpression.VarCharLiteral	copyOf(Expression.VarCharLiteral instance)	Creates an immutable copy of a Expression.VarCharLiteral value.
boolean	equals(Object another)	This instance is equal to all instances of VarCharLiteral that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: nullable, value, length.
int	length()
boolean	nullable()
String	toString()	Prints the immutable value VarCharLiteral with attribute values.
String	value()
final ImmutableExpression.VarCharLiteral	withLength(int value)	Copy the current immutable object by setting a value for the length attribute.
final ImmutableExpression.VarCharLiteral	withNullable(boolean value)	Copy the current immutable object by setting a value for the nullable attribute.
final ImmutableExpression.VarCharLiteral	withValue(String value)	Copy the current immutable object by setting a value for the value attribute.

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

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

value

public String value()

Specified by:

value in class Expression.VarCharLiteral

Returns:

The value of the value attribute

length

public int length()

Specified by:

length in class Expression.VarCharLiteral

Returns:

The value of the length attribute

withNullable

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

withValue

public final ImmutableExpression.VarCharLiteral withValue(String value)

Copy the current immutable object by setting a value for the value attribute. An equals check 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

withLength

public final ImmutableExpression.VarCharLiteral withLength(int value)

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

Parameters:

value - A new value for length

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of VarCharLiteral 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, value, length.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value VarCharLiteral with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableExpression.VarCharLiteral.Builder builder()

Creates a builder for VarCharLiteral.

 ImmutableExpression.VarCharLiteral.builder()
    .nullable(boolean) // optional nullable
    .value(String) // required value
    .length(int) // required length
    .build();
 

Returns:

A new VarCharLiteral builder