Package io.substrait.expression

Class ImmutableExpression.StrLiteral

java.lang.Object

io.substrait.expression.Expression.StrLiteral

io.substrait.expression.ImmutableExpression.StrLiteral

All Implemented Interfaces:

Expression, Expression.Literal, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.StrLiteral
extends Expression.StrLiteral

Immutable implementation of Expression.StrLiteral.

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

Nested Class Summary

Nested Classes

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

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

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

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.StrLiteral

Returns:

The value of the value attribute

withNullable

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

equals

public boolean equals(Object another)

This instance is equal to all instances of StrLiteral 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.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value StrLiteral with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableExpression.StrLiteral.Builder builder()

Creates a builder for StrLiteral.

 ImmutableExpression.StrLiteral.builder()
    .nullable(boolean) // optional nullable
    .value(String) // required value
    .build();
 

Returns:

A new StrLiteral builder