Package io.substrait.extension

Class ImmutableSimpleExtension.ExtensionCollection

java.lang.Object

io.substrait.extension.SimpleExtension.ExtensionCollection

io.substrait.extension.ImmutableSimpleExtension.ExtensionCollection

Enclosing class:

ImmutableSimpleExtension

public static final class ImmutableSimpleExtension.ExtensionCollection
extends SimpleExtension.ExtensionCollection

Immutable implementation of SimpleExtension.ExtensionCollection.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
List<SimpleExtension.AggregateFunctionVariant>	aggregateFunctions()
static ImmutableSimpleExtension.ExtensionCollection.Builder	builder()	Creates a builder for ExtensionCollection.
static ImmutableSimpleExtension.ExtensionCollection	copyOf(SimpleExtension.ExtensionCollection instance)	Creates an immutable copy of a SimpleExtension.ExtensionCollection value.
boolean	equals(Object another)	This instance is equal to all instances of ExtensionCollection that have equal attribute values.
Map<String,Map<String,Object>>	extensionMetadata()
int	hashCode()	Computes a hash code from attributes: extensionMetadata, types, scalarFunctions, aggregateFunctions, windowFunctions.
List<SimpleExtension.ScalarFunctionVariant>	scalarFunctions()
String	toString()	Prints the immutable value ExtensionCollection with attribute values.
List<SimpleExtension.Type>	types()
List<SimpleExtension.WindowFunctionVariant>	windowFunctions()
final ImmutableSimpleExtension.ExtensionCollection	withAggregateFunctions(SimpleExtension.AggregateFunctionVariant... elements)	Copy the current immutable object with elements that replace the content of aggregateFunctions.
final ImmutableSimpleExtension.ExtensionCollection	withAggregateFunctions(Iterable<? extends SimpleExtension.AggregateFunctionVariant> elements)	Copy the current immutable object with elements that replace the content of aggregateFunctions.
final ImmutableSimpleExtension.ExtensionCollection	withExtensionMetadata(Map<String,? extends Map<String,Object>> entries)	Copy the current immutable object by replacing the extensionMetadata map with the specified map.
final ImmutableSimpleExtension.ExtensionCollection	withScalarFunctions(SimpleExtension.ScalarFunctionVariant... elements)	Copy the current immutable object with elements that replace the content of scalarFunctions.
final ImmutableSimpleExtension.ExtensionCollection	withScalarFunctions(Iterable<? extends SimpleExtension.ScalarFunctionVariant> elements)	Copy the current immutable object with elements that replace the content of scalarFunctions.
final ImmutableSimpleExtension.ExtensionCollection	withTypes(SimpleExtension.Type... elements)	Copy the current immutable object with elements that replace the content of types.
final ImmutableSimpleExtension.ExtensionCollection	withTypes(Iterable<? extends SimpleExtension.Type> elements)	Copy the current immutable object with elements that replace the content of types.
final ImmutableSimpleExtension.ExtensionCollection	withWindowFunctions(SimpleExtension.WindowFunctionVariant... elements)	Copy the current immutable object with elements that replace the content of windowFunctions.
final ImmutableSimpleExtension.ExtensionCollection	withWindowFunctions(Iterable<? extends SimpleExtension.WindowFunctionVariant> elements)	Copy the current immutable object with elements that replace the content of windowFunctions.

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

getAggregateFunction, getExtensionMetadata, getScalarFunction, getType, getWindowFunction, merge

Methods inherited from class java.lang.Object

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

Method Details

extensionMetadata

public Map<String,Map<String,Object>> extensionMetadata()

Overrides:

extensionMetadata in class SimpleExtension.ExtensionCollection

Returns:

The value of the extensionMetadata attribute

types

public List<SimpleExtension.Type> types()

Specified by:

types in class SimpleExtension.ExtensionCollection

Returns:

The value of the types attribute

scalarFunctions

public List<SimpleExtension.ScalarFunctionVariant> scalarFunctions()

Specified by:

scalarFunctions in class SimpleExtension.ExtensionCollection

Returns:

The value of the scalarFunctions attribute

aggregateFunctions

public List<SimpleExtension.AggregateFunctionVariant> aggregateFunctions()

Specified by:

aggregateFunctions in class SimpleExtension.ExtensionCollection

Returns:

The value of the aggregateFunctions attribute

windowFunctions

public List<SimpleExtension.WindowFunctionVariant> windowFunctions()

Specified by:

windowFunctions in class SimpleExtension.ExtensionCollection

Returns:

The value of the windowFunctions attribute

withExtensionMetadata

public final ImmutableSimpleExtension.ExtensionCollection withExtensionMetadata(Map<String,? extends Map<String,Object>> entries)

Copy the current immutable object by replacing the extensionMetadata 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 extensionMetadata map

Returns:

A modified copy or this if not changed

withTypes

public final ImmutableSimpleExtension.ExtensionCollection withTypes(SimpleExtension.Type... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTypes

public final ImmutableSimpleExtension.ExtensionCollection withTypes(Iterable<? extends SimpleExtension.Type> elements)

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

Parameters:

elements - An iterable of types elements to set

Returns:

A modified copy or this if not changed

withScalarFunctions

public final ImmutableSimpleExtension.ExtensionCollection withScalarFunctions(SimpleExtension.ScalarFunctionVariant... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withScalarFunctions

public final ImmutableSimpleExtension.ExtensionCollection withScalarFunctions(Iterable<? extends SimpleExtension.ScalarFunctionVariant> elements)

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

Parameters:

elements - An iterable of scalarFunctions elements to set

Returns:

A modified copy or this if not changed

withAggregateFunctions

public final ImmutableSimpleExtension.ExtensionCollection withAggregateFunctions(SimpleExtension.AggregateFunctionVariant... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAggregateFunctions

public final ImmutableSimpleExtension.ExtensionCollection withAggregateFunctions(Iterable<? extends SimpleExtension.AggregateFunctionVariant> elements)

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

Parameters:

elements - An iterable of aggregateFunctions elements to set

Returns:

A modified copy or this if not changed

withWindowFunctions

public final ImmutableSimpleExtension.ExtensionCollection withWindowFunctions(SimpleExtension.WindowFunctionVariant... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withWindowFunctions

public final ImmutableSimpleExtension.ExtensionCollection withWindowFunctions(Iterable<? extends SimpleExtension.WindowFunctionVariant> elements)

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

Parameters:

elements - An iterable of windowFunctions elements to set

Returns:

A modified copy or this if not changed

equals

public boolean equals(Object another)

This instance is equal to all instances of ExtensionCollection 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: extensionMetadata, types, scalarFunctions, aggregateFunctions, windowFunctions.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ExtensionCollection with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableSimpleExtension.ExtensionCollection.Builder builder()

Creates a builder for ExtensionCollection.

 ImmutableSimpleExtension.ExtensionCollection.builder()
    .putExtensionMetadata|putAllExtensionMetadata(String => Map<String, Object>) // extensionMetadata mappings
    .addTypes|addAllTypes(io.substrait.extension.SimpleExtension.Type) // types elements
    .addScalarFunctions|addAllScalarFunctions(io.substrait.extension.SimpleExtension.ScalarFunctionVariant) // scalarFunctions elements
    .addAggregateFunctions|addAllAggregateFunctions(io.substrait.extension.SimpleExtension.AggregateFunctionVariant) // aggregateFunctions elements
    .addWindowFunctions|addAllWindowFunctions(io.substrait.extension.SimpleExtension.WindowFunctionVariant) // windowFunctions elements
    .build();
 

Returns:

A new ExtensionCollection builder