Package io.substrait.expression

Class ImmutableExpression.StructLiteral

java.lang.Object

io.substrait.expression.Expression.StructLiteral

io.substrait.expression.ImmutableExpression.StructLiteral

All Implemented Interfaces:

Expression, Expression.Literal, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.StructLiteral
extends Expression.StructLiteral

Immutable implementation of Expression.StructLiteral.

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

Nested Class Summary

Nested Classes

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

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

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

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

fields

public List<Expression.Literal> fields()

Specified by:

fields in class Expression.StructLiteral

Returns:

The value of the fields attribute

withNullable

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

withFields

public final ImmutableExpression.StructLiteral withFields(Expression.Literal... elements)

Copy the current immutable object with elements that replace the content of fields.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withFields

public final ImmutableExpression.StructLiteral withFields(Iterable<? extends Expression.Literal> elements)

Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of fields elements to set

Returns:

A modified copy or this if not changed

equals

public boolean equals(Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value StructLiteral with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableExpression.StructLiteral.Builder builder()

Creates a builder for StructLiteral.

 ImmutableExpression.StructLiteral.builder()
    .nullable(boolean) // optional nullable
    .addFields|addAllFields(io.substrait.expression.Expression.Literal) // fields elements
    .build();
 

Returns:

A new StructLiteral builder