Package io.substrait.extension

Class ImmutableSimpleExtension.ExtensionSignatures

java.lang.Object

io.substrait.extension.SimpleExtension.ExtensionSignatures

io.substrait.extension.ImmutableSimpleExtension.ExtensionSignatures

Enclosing class:

ImmutableSimpleExtension

public static final class ImmutableSimpleExtension.ExtensionSignatures
extends SimpleExtension.ExtensionSignatures

Immutable implementation of SimpleExtension.ExtensionSignatures.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
List<SimpleExtension.AggregateFunction>	aggregates()
static ImmutableSimpleExtension.ExtensionSignatures.Builder	builder()	Creates a builder for ExtensionSignatures.
static ImmutableSimpleExtension.ExtensionSignatures	copyOf(SimpleExtension.ExtensionSignatures instance)	Creates an immutable copy of a SimpleExtension.ExtensionSignatures value.
boolean	equals(Object another)	This instance is equal to all instances of ExtensionSignatures that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: types, urn, scalars, aggregates, windows, metadata.
Optional<Map<String,Object>>	metadata()
List<SimpleExtension.ScalarFunction>	scalars()
String	toString()	Prints the immutable value ExtensionSignatures with attribute values.
List<SimpleExtension.Type>	types()
String	urn()
List<SimpleExtension.WindowFunction>	windows()
final ImmutableSimpleExtension.ExtensionSignatures	withAggregates(SimpleExtension.AggregateFunction... elements)	Copy the current immutable object with elements that replace the content of aggregates.
final ImmutableSimpleExtension.ExtensionSignatures	withAggregates(Iterable<? extends SimpleExtension.AggregateFunction> elements)	Copy the current immutable object with elements that replace the content of aggregates.
final ImmutableSimpleExtension.ExtensionSignatures	withMetadata(Map<String,Object> value)	Copy the current immutable object by setting a present value for the optional metadata attribute.
final ImmutableSimpleExtension.ExtensionSignatures	withMetadata(Optional<? extends Map<String,Object>> optional)	Copy the current immutable object by setting an optional value for the metadata attribute.
final ImmutableSimpleExtension.ExtensionSignatures	withScalars(SimpleExtension.ScalarFunction... elements)	Copy the current immutable object with elements that replace the content of scalars.
final ImmutableSimpleExtension.ExtensionSignatures	withScalars(Iterable<? extends SimpleExtension.ScalarFunction> elements)	Copy the current immutable object with elements that replace the content of scalars.
final ImmutableSimpleExtension.ExtensionSignatures	withTypes(SimpleExtension.Type... elements)	Copy the current immutable object with elements that replace the content of types.
final ImmutableSimpleExtension.ExtensionSignatures	withTypes(Iterable<? extends SimpleExtension.Type> elements)	Copy the current immutable object with elements that replace the content of types.
final ImmutableSimpleExtension.ExtensionSignatures	withUrn(String value)	Copy the current immutable object by setting a value for the urn attribute.
final ImmutableSimpleExtension.ExtensionSignatures	withWindows(SimpleExtension.WindowFunction... elements)	Copy the current immutable object with elements that replace the content of windows.
final ImmutableSimpleExtension.ExtensionSignatures	withWindows(Iterable<? extends SimpleExtension.WindowFunction> elements)	Copy the current immutable object with elements that replace the content of windows.

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

resolve, size

Methods inherited from class java.lang.Object

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

Method Details

types

public List<SimpleExtension.Type> types()

Specified by:

types in class SimpleExtension.ExtensionSignatures

Returns:

The value of the types attribute

urn

public String urn()

Specified by:

urn in class SimpleExtension.ExtensionSignatures

Returns:

The value of the urn attribute

scalars

public List<SimpleExtension.ScalarFunction> scalars()

Specified by:

scalars in class SimpleExtension.ExtensionSignatures

Returns:

The value of the scalars attribute

aggregates

public List<SimpleExtension.AggregateFunction> aggregates()

Specified by:

aggregates in class SimpleExtension.ExtensionSignatures

Returns:

The value of the aggregates attribute

windows

public List<SimpleExtension.WindowFunction> windows()

Specified by:

windows in class SimpleExtension.ExtensionSignatures

Returns:

The value of the windows attribute

metadata

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

Specified by:

metadata in class SimpleExtension.ExtensionSignatures

Returns:

The value of the metadata attribute

withTypes

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

withUrn

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

withScalars

public final ImmutableSimpleExtension.ExtensionSignatures withScalars(SimpleExtension.ScalarFunction... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withScalars

public final ImmutableSimpleExtension.ExtensionSignatures withScalars(Iterable<? extends SimpleExtension.ScalarFunction> elements)

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

Parameters:

elements - An iterable of scalars elements to set

Returns:

A modified copy or this if not changed

withAggregates

public final ImmutableSimpleExtension.ExtensionSignatures withAggregates(SimpleExtension.AggregateFunction... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAggregates

public final ImmutableSimpleExtension.ExtensionSignatures withAggregates(Iterable<? extends SimpleExtension.AggregateFunction> elements)

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

Parameters:

elements - An iterable of aggregates elements to set

Returns:

A modified copy or this if not changed

withWindows

public final ImmutableSimpleExtension.ExtensionSignatures withWindows(SimpleExtension.WindowFunction... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withWindows

public final ImmutableSimpleExtension.ExtensionSignatures withWindows(Iterable<? extends SimpleExtension.WindowFunction> elements)

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

Parameters:

elements - An iterable of windows elements to set

Returns:

A modified copy or this if not changed

withMetadata

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

equals

public boolean equals(Object another)

This instance is equal to all instances of ExtensionSignatures 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: types, urn, scalars, aggregates, windows, metadata.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ExtensionSignatures with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableSimpleExtension.ExtensionSignatures.Builder builder()

Creates a builder for ExtensionSignatures.

 ImmutableSimpleExtension.ExtensionSignatures.builder()
    .addTypes|addAllTypes(io.substrait.extension.SimpleExtension.Type) // types elements
    .urn(String) // required urn
    .addScalars|addAllScalars(io.substrait.extension.SimpleExtension.ScalarFunction) // scalars elements
    .addAggregates|addAllAggregates(io.substrait.extension.SimpleExtension.AggregateFunction) // aggregates elements
    .addWindows|addAllWindows(io.substrait.extension.SimpleExtension.WindowFunction) // windows elements
    .metadata(Optional<Map<String, Object>>) // optional metadata
    .build();
 

Returns:

A new ExtensionSignatures builder