Package io.substrait.extension

Class ImmutableSimpleExtension.ScalarFunctionVariant.Builder

java.lang.Object

io.substrait.extension.ImmutableSimpleExtension.ScalarFunctionVariant.Builder

Enclosing class:

ImmutableSimpleExtension.ScalarFunctionVariant

public static final class ImmutableSimpleExtension.ScalarFunctionVariant.Builder
extends Object

Builds instances of type ScalarFunctionVariant. 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 ImmutableSimpleExtension.ScalarFunctionVariant.Builder	addAllArgs(Iterable<? extends SimpleExtension.Argument> elements)	Adds elements to args list.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	addArgs(SimpleExtension.Argument element)	Adds one element to args list.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	addArgs(SimpleExtension.Argument... elements)	Adds elements to args list.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	args(Iterable<? extends SimpleExtension.Argument> elements)	Sets or replaces all elements for args list.
ImmutableSimpleExtension.ScalarFunctionVariant	build()	Builds a new ScalarFunctionVariant.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	description(@Nullable String description)	Initializes the value for the description attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	from(SimpleExtension.Function instance)	Fill a builder with attribute values from the provided io.substrait.extension.SimpleExtension.Function instance.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	from(SimpleExtension.ScalarFunctionVariant instance)	Fill a builder with attribute values from the provided io.substrait.extension.SimpleExtension.ScalarFunctionVariant instance.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	metadata(Map<String,Object> metadata)	Initializes the optional value metadata to metadata.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	metadata(Optional<? extends Map<String,Object>> metadata)	Initializes the optional value metadata to metadata.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	name(String name)	Initializes the value for the name attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	nullability(SimpleExtension.Nullability nullability)	Initializes the value for the nullability attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	options(Map<String,? extends SimpleExtension.Option> entries)	Sets or replaces all mappings from the specified map as entries for the options map.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	ordered(@Nullable Boolean ordered)	Initializes the value for the ordered attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	putAllOptions(Map<String,? extends SimpleExtension.Option> entries)	Put all mappings from the specified map as entries to options map.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	putOptions(String key, SimpleExtension.Option value)	Put one entry to the options map.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	putOptions(Map.Entry<String,? extends SimpleExtension.Option> entry)	Put one entry to the options map.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	returnType(TypeExpression returnType)	Initializes the value for the returnType attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	urn(String urn)	Initializes the value for the urn attribute.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	variadic(SimpleExtension.VariadicBehavior variadic)	Initializes the optional value variadic to variadic.
final ImmutableSimpleExtension.ScalarFunctionVariant.Builder	variadic(Optional<? extends SimpleExtension.VariadicBehavior> variadic)	Initializes the optional value variadic to variadic.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder from(SimpleExtension.Function instance)

Fill a builder with attribute values from the provided io.substrait.extension.SimpleExtension.Function instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder from(SimpleExtension.ScalarFunctionVariant instance)

Fill a builder with attribute values from the provided io.substrait.extension.SimpleExtension.ScalarFunctionVariant instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

name

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder name(String name)

Initializes the value for the name attribute.

If not set, this attribute will have a default value as returned by the initializer of name.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

urn

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder urn(String urn)

Initializes the value for the urn attribute.

If not set, this attribute will have a default value as returned by the initializer of urn.

Parameters:

urn - The value for urn

Returns:

this builder for use in a chained invocation

variadic

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder variadic(SimpleExtension.VariadicBehavior variadic)

Initializes the optional value variadic to variadic.

Parameters:

variadic - The value for variadic

Returns:

this builder for chained invocation

variadic

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder variadic(Optional<? extends SimpleExtension.VariadicBehavior> variadic)

Initializes the optional value variadic to variadic.

Parameters:

variadic - The value for variadic

Returns:

this builder for use in a chained invocation

description

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder description(@Nullable String description)

Initializes the value for the description attribute.

If not set, this attribute will have a default value as returned by the initializer of description.

Parameters:

description - The value for description (can be null)

Returns:

this builder for use in a chained invocation

addArgs

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder addArgs(SimpleExtension.Argument element)

Adds one element to args list.

Parameters:

element - A args element

Returns:

this builder for use in a chained invocation

addArgs

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder addArgs(SimpleExtension.Argument... elements)

Adds elements to args list.

Parameters:

elements - An array of args elements

Returns:

this builder for use in a chained invocation

args

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder args(Iterable<? extends SimpleExtension.Argument> elements)

Sets or replaces all elements for args list.

Parameters:

elements - An iterable of args elements

Returns:

this builder for use in a chained invocation

addAllArgs

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder addAllArgs(Iterable<? extends SimpleExtension.Argument> elements)

Adds elements to args list.

Parameters:

elements - An iterable of args elements

Returns:

this builder for use in a chained invocation

putOptions

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder putOptions(String key,
 SimpleExtension.Option value)

Put one entry to the options map.

Parameters:

key - The key in the options map

value - The associated value in the options map

Returns:

this builder for use in a chained invocation

putOptions

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder putOptions(Map.Entry<String,? extends SimpleExtension.Option> entry)

Put one entry to the options map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

options

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder options(Map<String,? extends SimpleExtension.Option> entries)

Sets or replaces all mappings from the specified map as entries for the options map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the options map

Returns:

this builder for use in a chained invocation

putAllOptions

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder putAllOptions(Map<String,? extends SimpleExtension.Option> entries)

Put all mappings from the specified map as entries to options map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the options map

Returns:

this builder for use in a chained invocation

metadata

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder metadata(Map<String,Object> metadata)

Initializes the optional value metadata to metadata.

Parameters:

metadata - The value for metadata

Returns:

this builder for chained invocation

metadata

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder metadata(Optional<? extends Map<String,Object>> metadata)

Initializes the optional value metadata to metadata.

Parameters:

metadata - The value for metadata

Returns:

this builder for use in a chained invocation

nullability

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder nullability(SimpleExtension.Nullability nullability)

Initializes the value for the nullability attribute.

If not set, this attribute will have a default value as returned by the initializer of nullability.

Parameters:

nullability - The value for nullability

Returns:

this builder for use in a chained invocation

ordered

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder ordered(@Nullable Boolean ordered)

Initializes the value for the ordered attribute.

Parameters:

ordered - The value for ordered (can be null)

Returns:

this builder for use in a chained invocation

returnType

public final ImmutableSimpleExtension.ScalarFunctionVariant.Builder returnType(TypeExpression returnType)

Initializes the value for the returnType attribute.

Parameters:

returnType - The value for returnType

Returns:

this builder for use in a chained invocation

build

public ImmutableSimpleExtension.ScalarFunctionVariant build()

Builds a new ScalarFunctionVariant.

Returns:

An immutable instance of ScalarFunctionVariant

Throws:

IllegalStateException - if any required attributes are missing