Package io.substrait.expression

Class ImmutableExpression.ScalarFunctionInvocation.Builder

java.lang.Object

io.substrait.expression.ImmutableExpression.ScalarFunctionInvocation.Builder

Enclosing class:

ImmutableExpression.ScalarFunctionInvocation

public static final class ImmutableExpression.ScalarFunctionInvocation.Builder
extends Object

Builds instances of type ScalarFunctionInvocation. 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 ImmutableExpression.ScalarFunctionInvocation.Builder	addAllArguments(Iterable<? extends FunctionArg> elements)	Adds elements to arguments list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	addAllOptions(Iterable<? extends FunctionOption> elements)	Adds elements to options list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	addArguments(FunctionArg element)	Adds one element to arguments list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	addArguments(FunctionArg... elements)	Adds elements to arguments list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	addOptions(FunctionOption element)	Adds one element to options list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	addOptions(FunctionOption... elements)	Adds elements to options list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	arguments(Iterable<? extends FunctionArg> elements)	Sets or replaces all elements for arguments list.
ImmutableExpression.ScalarFunctionInvocation	build()	Builds a new ScalarFunctionInvocation.
final ImmutableExpression.ScalarFunctionInvocation.Builder	declaration(SimpleExtension.ScalarFunctionVariant declaration)	Initializes the value for the declaration attribute.
final ImmutableExpression.ScalarFunctionInvocation.Builder	from(Expression.ScalarFunctionInvocation instance)	Fill a builder with attribute values from the provided ScalarFunctionInvocation instance.
final ImmutableExpression.ScalarFunctionInvocation.Builder	options(Iterable<? extends FunctionOption> elements)	Sets or replaces all elements for options list.
final ImmutableExpression.ScalarFunctionInvocation.Builder	outputType(Type outputType)	Initializes the value for the outputType attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableExpression.ScalarFunctionInvocation.Builder from(Expression.ScalarFunctionInvocation instance)

Fill a builder with attribute values from the provided ScalarFunctionInvocation 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

declaration

public final ImmutableExpression.ScalarFunctionInvocation.Builder declaration(SimpleExtension.ScalarFunctionVariant declaration)

Initializes the value for the declaration attribute.

Parameters:

declaration - The value for declaration

Returns:

this builder for use in a chained invocation

addArguments

public final ImmutableExpression.ScalarFunctionInvocation.Builder addArguments(FunctionArg element)

Adds one element to arguments list.

Parameters:

element - A arguments element

Returns:

this builder for use in a chained invocation

addArguments

public final ImmutableExpression.ScalarFunctionInvocation.Builder addArguments(FunctionArg... elements)

Adds elements to arguments list.

Parameters:

elements - An array of arguments elements

Returns:

this builder for use in a chained invocation

arguments

public final ImmutableExpression.ScalarFunctionInvocation.Builder arguments(Iterable<? extends FunctionArg> elements)

Sets or replaces all elements for arguments list.

Parameters:

elements - An iterable of arguments elements

Returns:

this builder for use in a chained invocation

addAllArguments

public final ImmutableExpression.ScalarFunctionInvocation.Builder addAllArguments(Iterable<? extends FunctionArg> elements)

Adds elements to arguments list.

Parameters:

elements - An iterable of arguments elements

Returns:

this builder for use in a chained invocation

addOptions

public final ImmutableExpression.ScalarFunctionInvocation.Builder addOptions(FunctionOption element)

Adds one element to options list.

Parameters:

element - A options element

Returns:

this builder for use in a chained invocation

addOptions

public final ImmutableExpression.ScalarFunctionInvocation.Builder addOptions(FunctionOption... elements)

Adds elements to options list.

Parameters:

elements - An array of options elements

Returns:

this builder for use in a chained invocation

options

public final ImmutableExpression.ScalarFunctionInvocation.Builder options(Iterable<? extends FunctionOption> elements)

Sets or replaces all elements for options list.

Parameters:

elements - An iterable of options elements

Returns:

this builder for use in a chained invocation

addAllOptions

public final ImmutableExpression.ScalarFunctionInvocation.Builder addAllOptions(Iterable<? extends FunctionOption> elements)

Adds elements to options list.

Parameters:

elements - An iterable of options elements

Returns:

this builder for use in a chained invocation

outputType

public final ImmutableExpression.ScalarFunctionInvocation.Builder outputType(Type outputType)

Initializes the value for the outputType attribute.

Parameters:

outputType - The value for outputType

Returns:

this builder for use in a chained invocation

build

public ImmutableExpression.ScalarFunctionInvocation build()

Builds a new ScalarFunctionInvocation.

Returns:

An immutable instance of ScalarFunctionInvocation

Throws:

IllegalStateException - if any required attributes are missing