Package io.substrait.extension

Class ImmutableSimpleExtension.AggregateFunctionVariant

java.lang.Object

io.substrait.extension.SimpleExtension.Function

io.substrait.extension.SimpleExtension.AggregateFunctionVariant

io.substrait.extension.ImmutableSimpleExtension.AggregateFunctionVariant

Enclosing class:

ImmutableSimpleExtension

public static final class ImmutableSimpleExtension.AggregateFunctionVariant
extends SimpleExtension.AggregateFunctionVariant

Immutable implementation of SimpleExtension.AggregateFunctionVariant.

Use the builder to create immutable instances: ImmutableSimpleExtension.AggregateFunctionVariant.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableSimpleExtension.AggregateFunctionVariant.Builder	Builds instances of type AggregateFunctionVariant.

Method Summary

Modifier and Type	Method	Description
List<SimpleExtension.Argument>	args()
static ImmutableSimpleExtension.AggregateFunctionVariant.Builder	builder()	Creates a builder for AggregateFunctionVariant.
static ImmutableSimpleExtension.AggregateFunctionVariant	copyOf(SimpleExtension.AggregateFunctionVariant instance)	Creates an immutable copy of a SimpleExtension.AggregateFunctionVariant value.
SimpleExtension.Decomposability	decomposability()
@Nullable String	description()
boolean	equals(Object another)	This instance is equal to all instances of AggregateFunctionVariant that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: name, urn, variadic, description, args, options, metadata, nullability, ordered, returnType, decomposability, intermediate.
@Nullable TypeExpression	intermediate()
Optional<Map<String,Object>>	metadata()
String	name()
SimpleExtension.Nullability	nullability()
Map<String,SimpleExtension.Option>	options()
@Nullable Boolean	ordered()
TypeExpression	returnType()
String	urn()
Optional<SimpleExtension.VariadicBehavior>	variadic()
final ImmutableSimpleExtension.AggregateFunctionVariant	withArgs(SimpleExtension.Argument... elements)	Copy the current immutable object with elements that replace the content of args.
final ImmutableSimpleExtension.AggregateFunctionVariant	withArgs(Iterable<? extends SimpleExtension.Argument> elements)	Copy the current immutable object with elements that replace the content of args.
final ImmutableSimpleExtension.AggregateFunctionVariant	withDecomposability(SimpleExtension.Decomposability value)	Copy the current immutable object by setting a value for the decomposability attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withDescription(@Nullable String value)	Copy the current immutable object by setting a value for the description attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withIntermediate(@Nullable TypeExpression value)	Copy the current immutable object by setting a value for the intermediate attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withMetadata(Map<String,Object> value)	Copy the current immutable object by setting a present value for the optional metadata attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withMetadata(Optional<? extends Map<String,Object>> optional)	Copy the current immutable object by setting an optional value for the metadata attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withNullability(SimpleExtension.Nullability value)	Copy the current immutable object by setting a value for the nullability attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withOptions(Map<String,? extends SimpleExtension.Option> entries)	Copy the current immutable object by replacing the options map with the specified map.
final ImmutableSimpleExtension.AggregateFunctionVariant	withOrdered(@Nullable Boolean value)	Copy the current immutable object by setting a value for the ordered attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withReturnType(TypeExpression value)	Copy the current immutable object by setting a value for the returnType attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withUrn(String value)	Copy the current immutable object by setting a value for the urn attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withVariadic(SimpleExtension.VariadicBehavior value)	Copy the current immutable object by setting a present value for the optional variadic attribute.
final ImmutableSimpleExtension.AggregateFunctionVariant	withVariadic(Optional<? extends SimpleExtension.VariadicBehavior> optional)	Copy the current immutable object by setting an optional value for the variadic attribute.

Methods inherited from class io.substrait.extension.SimpleExtension.AggregateFunctionVariant

toString

Methods inherited from class io.substrait.extension.SimpleExtension.Function

constructKey, constructKeyFromTypes, getAnchor, getRange, key, requiredArguments, resolveType, validateOutputType

Methods inherited from class java.lang.Object

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

Method Details

name

public String name()

Overrides:

name in class SimpleExtension.Function

Returns:

The value of the name attribute

urn

public String urn()

Overrides:

urn in class SimpleExtension.Function

Returns:

The value of the urn attribute

variadic

public Optional<SimpleExtension.VariadicBehavior> variadic()

Specified by:

variadic in class SimpleExtension.Function

Returns:

The value of the variadic attribute

description

public @Nullable String description()

Overrides:

description in class SimpleExtension.Function

Returns:

The value of the description attribute

args

public List<SimpleExtension.Argument> args()

Specified by:

args in class SimpleExtension.Function

Returns:

The value of the args attribute

options

public Map<String,SimpleExtension.Option> options()

Specified by:

options in class SimpleExtension.Function

Returns:

The value of the options attribute

metadata

public Optional<Map<String,Object>> metadata()

Specified by:

metadata in class SimpleExtension.Function

Returns:

The value of the metadata attribute

nullability

public SimpleExtension.Nullability nullability()

Overrides:

nullability in class SimpleExtension.Function

Returns:

The value of the nullability attribute

ordered

public @Nullable Boolean ordered()

Specified by:

ordered in class SimpleExtension.Function

Returns:

The value of the ordered attribute

returnType

public TypeExpression returnType()

Specified by:

returnType in class SimpleExtension.Function

Returns:

The value of the returnType attribute

decomposability

public SimpleExtension.Decomposability decomposability()

Overrides:

decomposability in class SimpleExtension.AggregateFunctionVariant

Returns:

The value of the decomposability attribute

intermediate

public @Nullable TypeExpression intermediate()

Specified by:

intermediate in class SimpleExtension.AggregateFunctionVariant

Returns:

The value of the intermediate attribute

withName

public final ImmutableSimpleExtension.AggregateFunctionVariant 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

withUrn

public final ImmutableSimpleExtension.AggregateFunctionVariant 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

withVariadic

public final ImmutableSimpleExtension.AggregateFunctionVariant withVariadic(SimpleExtension.VariadicBehavior value)

Copy the current immutable object by setting a present value for the optional variadic attribute.

Parameters:

value - The value for variadic

Returns:

A modified copy or this if not changed

withVariadic

public final ImmutableSimpleExtension.AggregateFunctionVariant withVariadic(Optional<? extends SimpleExtension.VariadicBehavior> optional)

Copy the current immutable object by setting an optional value for the variadic attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for variadic

Returns:

A modified copy or this if not changed

withDescription

public final ImmutableSimpleExtension.AggregateFunctionVariant withDescription(@Nullable String value)

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

Parameters:

value - A new value for description (can be null)

Returns:

A modified copy or the this object

withArgs

public final ImmutableSimpleExtension.AggregateFunctionVariant withArgs(SimpleExtension.Argument... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArgs

public final ImmutableSimpleExtension.AggregateFunctionVariant withArgs(Iterable<? extends SimpleExtension.Argument> elements)

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

Parameters:

elements - An iterable of args elements to set

Returns:

A modified copy or this if not changed

withOptions

public final ImmutableSimpleExtension.AggregateFunctionVariant withOptions(Map<String,? extends SimpleExtension.Option> entries)

Copy the current immutable object by replacing the options map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to replace the options map

Returns:

A modified copy or this if not changed

withMetadata

public final ImmutableSimpleExtension.AggregateFunctionVariant withMetadata(Map<String,Object> value)

Copy the current immutable object by setting a present value for the optional metadata attribute.

Parameters:

value - The value for metadata

Returns:

A modified copy or this if not changed

withMetadata

public final ImmutableSimpleExtension.AggregateFunctionVariant withMetadata(Optional<? extends Map<String,Object>> optional)

Copy the current immutable object by setting an optional value for the metadata attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for metadata

Returns:

A modified copy or this if not changed

withNullability

public final ImmutableSimpleExtension.AggregateFunctionVariant withNullability(SimpleExtension.Nullability value)

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

Parameters:

value - A new value for nullability

Returns:

A modified copy or the this object

withOrdered

public final ImmutableSimpleExtension.AggregateFunctionVariant withOrdered(@Nullable Boolean value)

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

Parameters:

value - A new value for ordered (can be null)

Returns:

A modified copy or the this object

withReturnType

public final ImmutableSimpleExtension.AggregateFunctionVariant withReturnType(TypeExpression value)

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

Parameters:

value - A new value for returnType

Returns:

A modified copy or the this object

withDecomposability

public final ImmutableSimpleExtension.AggregateFunctionVariant withDecomposability(SimpleExtension.Decomposability value)

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

Parameters:

value - A new value for decomposability

Returns:

A modified copy or the this object

withIntermediate

public final ImmutableSimpleExtension.AggregateFunctionVariant withIntermediate(@Nullable TypeExpression value)

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

Parameters:

value - A new value for intermediate (can be null)

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of AggregateFunctionVariant 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: name, urn, variadic, description, args, options, metadata, nullability, ordered, returnType, decomposability, intermediate.

Overrides:

hashCode in class Object

Returns:

hashCode value

copyOf

public static ImmutableSimpleExtension.AggregateFunctionVariant copyOf(SimpleExtension.AggregateFunctionVariant instance)

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

builder

public static ImmutableSimpleExtension.AggregateFunctionVariant.Builder builder()

Creates a builder for AggregateFunctionVariant.

 ImmutableSimpleExtension.AggregateFunctionVariant.builder()
    .name(String) // optional name
    .urn(String) // optional urn
    .variadic(Optional<io.substrait.extension.SimpleExtension.VariadicBehavior>) // optional variadic
    .description(String | null) // nullable description
    .addArgs|addAllArgs(io.substrait.extension.SimpleExtension.Argument) // args elements
    .putOptions|putAllOptions(String => io.substrait.extension.SimpleExtension.Option) // options mappings
    .metadata(Optional<Map<String, Object>>) // optional metadata
    .nullability(io.substrait.extension.SimpleExtension.Nullability) // optional nullability
    .ordered(Boolean | null) // nullable ordered
    .returnType(io.substrait.function.TypeExpression) // required returnType
    .decomposability(io.substrait.extension.SimpleExtension.Decomposability) // optional decomposability
    .intermediate(io.substrait.function.TypeExpression | null) // nullable intermediate
    .build();
 

Returns:

A new AggregateFunctionVariant builder