Package io.substrait.expression

Class ImmutableExpression.UserDefinedStructLiteral

java.lang.Object

io.substrait.expression.Expression.UserDefinedStructLiteral

io.substrait.expression.ImmutableExpression.UserDefinedStructLiteral

All Implemented Interfaces:

Expression, Expression.Literal, Expression.UserDefinedLiteral, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.UserDefinedStructLiteral
extends Expression.UserDefinedStructLiteral

Immutable implementation of Expression.UserDefinedStructLiteral.

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

Nested Class Summary

Nested Classes

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

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

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

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

urn

public String urn()

Specified by:

urn in interface Expression.UserDefinedLiteral

Specified by:

urn in class Expression.UserDefinedStructLiteral

Returns:

The value of the urn attribute

name

public String name()

Specified by:

name in interface Expression.UserDefinedLiteral

Specified by:

name in class Expression.UserDefinedStructLiteral

Returns:

The value of the name attribute

typeParameters

public List<Type.Parameter> typeParameters()

Specified by:

typeParameters in interface Expression.UserDefinedLiteral

Specified by:

typeParameters in class Expression.UserDefinedStructLiteral

Returns:

The value of the typeParameters attribute

fields

public List<Expression.Literal> fields()

Specified by:

fields in class Expression.UserDefinedStructLiteral

Returns:

The value of the fields attribute

withNullable

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

withUrn

public final ImmutableExpression.UserDefinedStructLiteral withUrn(String value)

Copy the current immutable object by setting a value for the urn attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for urn

Returns:

A modified copy or the this object

withName

public final ImmutableExpression.UserDefinedStructLiteral withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy or the this object

withTypeParameters

public final ImmutableExpression.UserDefinedStructLiteral withTypeParameters(Type.Parameter... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTypeParameters

public final ImmutableExpression.UserDefinedStructLiteral withTypeParameters(Iterable<? extends Type.Parameter> elements)

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

Parameters:

elements - An iterable of typeParameters elements to set

Returns:

A modified copy or this if not changed

withFields

public final ImmutableExpression.UserDefinedStructLiteral 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.UserDefinedStructLiteral 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 UserDefinedStructLiteral 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, urn, name, typeParameters, fields.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value UserDefinedStructLiteral with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableExpression.UserDefinedStructLiteral.Builder builder()

Creates a builder for UserDefinedStructLiteral.

 ImmutableExpression.UserDefinedStructLiteral.builder()
    .nullable(boolean) // optional nullable
    .urn(String) // required urn
    .name(String) // required name
    .addTypeParameters|addAllTypeParameters(io.substrait.type.Type.Parameter) // typeParameters elements
    .addFields|addAllFields(io.substrait.expression.Expression.Literal) // fields elements
    .build();
 

Returns:

A new UserDefinedStructLiteral builder