Package io.substrait.function

Class ImmutableTypeExpression.ReturnProgram

java.lang.Object

io.substrait.function.TypeExpression.BaseTypeExpression

io.substrait.function.TypeExpression.ReturnProgram

io.substrait.function.ImmutableTypeExpression.ReturnProgram

All Implemented Interfaces:

TypeExpression

Enclosing class:

ImmutableTypeExpression

public static final class ImmutableTypeExpression.ReturnProgram
extends TypeExpression.ReturnProgram

Immutable implementation of TypeExpression.ReturnProgram.

Use the builder to create immutable instances: ImmutableTypeExpression.ReturnProgram.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableTypeExpression.ReturnProgram.Builder	Builds instances of type ReturnProgram.

Nested classes/interfaces inherited from class io.substrait.function.TypeExpression.ReturnProgram

TypeExpression.ReturnProgram.Assignment

Nested classes/interfaces inherited from interface io.substrait.function.TypeExpression

TypeExpression.BaseTypeExpression, TypeExpression.BinaryOperation, TypeExpression.Decimal, TypeExpression.FixedBinary, TypeExpression.FixedChar, TypeExpression.Func, TypeExpression.IfOperation, TypeExpression.IntegerLiteral, TypeExpression.IntervalCompound, TypeExpression.IntervalDay, TypeExpression.ListType, TypeExpression.Map, TypeExpression.NotOperation, TypeExpression.PrecisionTime, TypeExpression.PrecisionTimestamp, TypeExpression.PrecisionTimestampTZ, TypeExpression.RequiredTypeExpressionVisitorException, TypeExpression.ReturnProgram, TypeExpression.Struct, TypeExpression.VarChar

Method Summary

Modifier and Type	Method	Description
List<TypeExpression.ReturnProgram.Assignment>	assignments()
static ImmutableTypeExpression.ReturnProgram.Builder	builder()	Creates a builder for ReturnProgram.
static ImmutableTypeExpression.ReturnProgram	copyOf(TypeExpression.ReturnProgram instance)	Creates an immutable copy of a TypeExpression.ReturnProgram value.
boolean	equals(Object another)	This instance is equal to all instances of ReturnProgram that have equal attribute values.
TypeExpression	finalExpression()
int	hashCode()	Computes a hash code from attributes: assignments, finalExpression.
String	toString()	Prints the immutable value ReturnProgram with attribute values.
final ImmutableTypeExpression.ReturnProgram	withAssignments(TypeExpression.ReturnProgram.Assignment... elements)	Copy the current immutable object with elements that replace the content of assignments.
final ImmutableTypeExpression.ReturnProgram	withAssignments(Iterable<? extends TypeExpression.ReturnProgram.Assignment> elements)	Copy the current immutable object with elements that replace the content of assignments.
final ImmutableTypeExpression.ReturnProgram	withFinalExpression(TypeExpression value)	Copy the current immutable object by setting a value for the finalExpression attribute.

Methods inherited from class io.substrait.function.TypeExpression.BaseTypeExpression

accept

Methods inherited from class java.lang.Object

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

Method Details

assignments

public List<TypeExpression.ReturnProgram.Assignment> assignments()

Specified by:

assignments in class TypeExpression.ReturnProgram

Returns:

The value of the assignments attribute

finalExpression

public TypeExpression finalExpression()

Specified by:

finalExpression in class TypeExpression.ReturnProgram

Returns:

The value of the finalExpression attribute

withAssignments

public final ImmutableTypeExpression.ReturnProgram withAssignments(TypeExpression.ReturnProgram.Assignment... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAssignments

public final ImmutableTypeExpression.ReturnProgram withAssignments(Iterable<? extends TypeExpression.ReturnProgram.Assignment> elements)

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

Parameters:

elements - An iterable of assignments elements to set

Returns:

A modified copy or this if not changed

withFinalExpression

public final ImmutableTypeExpression.ReturnProgram withFinalExpression(TypeExpression value)

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

Parameters:

value - A new value for finalExpression

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ReturnProgram 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: assignments, finalExpression.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ReturnProgram with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableTypeExpression.ReturnProgram copyOf(TypeExpression.ReturnProgram instance)

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

builder

public static ImmutableTypeExpression.ReturnProgram.Builder builder()

Creates a builder for ReturnProgram.

 ImmutableTypeExpression.ReturnProgram.builder()
    .addAssignments|addAllAssignments(io.substrait.function.TypeExpression.ReturnProgram.Assignment) // assignments elements
    .finalExpression(io.substrait.function.TypeExpression) // required finalExpression
    .build();
 

Returns:

A new ReturnProgram builder