Package io.substrait.expression

Class ImmutableFieldReference.Builder

java.lang.Object

io.substrait.expression.ImmutableFieldReference.Builder

Enclosing class:

ImmutableFieldReference

public static final class ImmutableFieldReference.Builder
extends Object

Builds instances of type ImmutableFieldReference. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableFieldReference.Builder	addAllSegments(Iterable<? extends FieldReference.ReferenceSegment> elements)	Adds elements to segments list.
final ImmutableFieldReference.Builder	addSegments(FieldReference.ReferenceSegment element)	Adds one element to segments list.
final ImmutableFieldReference.Builder	addSegments(FieldReference.ReferenceSegment... elements)	Adds elements to segments list.
ImmutableFieldReference	build()	Builds a new ImmutableFieldReference.
final ImmutableFieldReference.Builder	from(FieldReference instance)	Fill a builder with attribute values from the provided FieldReference instance.
final ImmutableFieldReference.Builder	inputExpression(Expression inputExpression)	Initializes the optional value inputExpression to inputExpression.
final ImmutableFieldReference.Builder	inputExpression(Optional<? extends Expression> inputExpression)	Initializes the optional value inputExpression to inputExpression.
final ImmutableFieldReference.Builder	lambdaParameterReferenceStepsOut(int lambdaParameterReferenceStepsOut)	Initializes the optional value lambdaParameterReferenceStepsOut to lambdaParameterReferenceStepsOut.
final ImmutableFieldReference.Builder	lambdaParameterReferenceStepsOut(Optional<Integer> lambdaParameterReferenceStepsOut)	Initializes the optional value lambdaParameterReferenceStepsOut to lambdaParameterReferenceStepsOut.
final ImmutableFieldReference.Builder	outerReferenceStepsOut(int outerReferenceStepsOut)	Initializes the optional value outerReferenceStepsOut to outerReferenceStepsOut.
final ImmutableFieldReference.Builder	outerReferenceStepsOut(Optional<Integer> outerReferenceStepsOut)	Initializes the optional value outerReferenceStepsOut to outerReferenceStepsOut.
final ImmutableFieldReference.Builder	segments(Iterable<? extends FieldReference.ReferenceSegment> elements)	Sets or replaces all elements for segments list.
final ImmutableFieldReference.Builder	type(Type type)	Initializes the value for the type attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public final ImmutableFieldReference.Builder from(FieldReference instance)

Fill a builder with attribute values from the provided FieldReference instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

addSegments

public final ImmutableFieldReference.Builder addSegments(FieldReference.ReferenceSegment element)

Adds one element to segments list.

Parameters:

element - A segments element

Returns:

this builder for use in a chained invocation

addSegments

public final ImmutableFieldReference.Builder addSegments(FieldReference.ReferenceSegment... elements)

Adds elements to segments list.

Parameters:

elements - An array of segments elements

Returns:

this builder for use in a chained invocation

segments

public final ImmutableFieldReference.Builder segments(Iterable<? extends FieldReference.ReferenceSegment> elements)

Sets or replaces all elements for segments list.

Parameters:

elements - An iterable of segments elements

Returns:

this builder for use in a chained invocation

addAllSegments

public final ImmutableFieldReference.Builder addAllSegments(Iterable<? extends FieldReference.ReferenceSegment> elements)

Adds elements to segments list.

Parameters:

elements - An iterable of segments elements

Returns:

this builder for use in a chained invocation

type

public final ImmutableFieldReference.Builder type(Type type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

inputExpression

public final ImmutableFieldReference.Builder inputExpression(Expression inputExpression)

Initializes the optional value inputExpression to inputExpression.

Parameters:

inputExpression - The value for inputExpression

Returns:

this builder for chained invocation

inputExpression

public final ImmutableFieldReference.Builder inputExpression(Optional<? extends Expression> inputExpression)

Initializes the optional value inputExpression to inputExpression.

Parameters:

inputExpression - The value for inputExpression

Returns:

this builder for use in a chained invocation

outerReferenceStepsOut

public final ImmutableFieldReference.Builder outerReferenceStepsOut(int outerReferenceStepsOut)

Initializes the optional value outerReferenceStepsOut to outerReferenceStepsOut.

Parameters:

outerReferenceStepsOut - The value for outerReferenceStepsOut

Returns:

this builder for chained invocation

outerReferenceStepsOut

public final ImmutableFieldReference.Builder outerReferenceStepsOut(Optional<Integer> outerReferenceStepsOut)

Initializes the optional value outerReferenceStepsOut to outerReferenceStepsOut.

Parameters:

outerReferenceStepsOut - The value for outerReferenceStepsOut

Returns:

this builder for use in a chained invocation

lambdaParameterReferenceStepsOut

public final ImmutableFieldReference.Builder lambdaParameterReferenceStepsOut(int lambdaParameterReferenceStepsOut)

Initializes the optional value lambdaParameterReferenceStepsOut to lambdaParameterReferenceStepsOut.

Parameters:

lambdaParameterReferenceStepsOut - The value for lambdaParameterReferenceStepsOut

Returns:

this builder for chained invocation

lambdaParameterReferenceStepsOut

public final ImmutableFieldReference.Builder lambdaParameterReferenceStepsOut(Optional<Integer> lambdaParameterReferenceStepsOut)

Initializes the optional value lambdaParameterReferenceStepsOut to lambdaParameterReferenceStepsOut.

Parameters:

lambdaParameterReferenceStepsOut - The value for lambdaParameterReferenceStepsOut

Returns:

this builder for use in a chained invocation

build

public ImmutableFieldReference build()

Builds a new ImmutableFieldReference.

Returns:

An immutable instance of FieldReference

Throws:

IllegalStateException - if any required attributes are missing