Package io.substrait.extension

Class ImmutableSimpleExtension.ScalarFunction

java.lang.Object

io.substrait.extension.SimpleExtension.ScalarFunction

io.substrait.extension.ImmutableSimpleExtension.ScalarFunction

Enclosing class:

ImmutableSimpleExtension

public static final class ImmutableSimpleExtension.ScalarFunction
extends SimpleExtension.ScalarFunction

Immutable implementation of SimpleExtension.ScalarFunction.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableSimpleExtension.ScalarFunction.Builder	builder()	Creates a builder for ScalarFunction.
static ImmutableSimpleExtension.ScalarFunction	copyOf(SimpleExtension.ScalarFunction instance)	Creates an immutable copy of a SimpleExtension.ScalarFunction value.
@Nullable String	description()
boolean	equals(Object another)	This instance is equal to all instances of ScalarFunction that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: name, description, metadata, impls.
List<SimpleExtension.ScalarFunctionVariant>	impls()
Optional<Map<String,Object>>	metadata()
String	name()
String	toString()	Prints the immutable value ScalarFunction with attribute values.
final ImmutableSimpleExtension.ScalarFunction	withDescription(@Nullable String value)	Copy the current immutable object by setting a value for the description attribute.
final ImmutableSimpleExtension.ScalarFunction	withImpls(SimpleExtension.ScalarFunctionVariant... elements)	Copy the current immutable object with elements that replace the content of impls.
final ImmutableSimpleExtension.ScalarFunction	withImpls(Iterable<? extends SimpleExtension.ScalarFunctionVariant> elements)	Copy the current immutable object with elements that replace the content of impls.
final ImmutableSimpleExtension.ScalarFunction	withMetadata(Map<String,Object> value)	Copy the current immutable object by setting a present value for the optional metadata attribute.
final ImmutableSimpleExtension.ScalarFunction	withMetadata(Optional<? extends Map<String,Object>> optional)	Copy the current immutable object by setting an optional value for the metadata attribute.
final ImmutableSimpleExtension.ScalarFunction	withName(String value)	Copy the current immutable object by setting a value for the name attribute.

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

resolve

Methods inherited from class java.lang.Object

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

Method Details

name

public String name()

Specified by:

name in class SimpleExtension.ScalarFunction

Returns:

The value of the name attribute

description

public @Nullable String description()

Specified by:

description in class SimpleExtension.ScalarFunction

Returns:

The value of the description attribute

metadata

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

Specified by:

metadata in class SimpleExtension.ScalarFunction

Returns:

The value of the metadata attribute

impls

public List<SimpleExtension.ScalarFunctionVariant> impls()

Specified by:

impls in class SimpleExtension.ScalarFunction

Returns:

The value of the impls attribute

withName

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

withDescription

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

withMetadata

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

withImpls

public final ImmutableSimpleExtension.ScalarFunction withImpls(SimpleExtension.ScalarFunctionVariant... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withImpls

public final ImmutableSimpleExtension.ScalarFunction withImpls(Iterable<? extends SimpleExtension.ScalarFunctionVariant> elements)

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

Parameters:

elements - An iterable of impls 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 ScalarFunction 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, description, metadata, impls.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ScalarFunction with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableSimpleExtension.ScalarFunction.Builder builder()

Creates a builder for ScalarFunction.

 ImmutableSimpleExtension.ScalarFunction.builder()
    .name(String) // required name
    .description(String | null) // nullable description
    .metadata(Optional<Map<String, Object>>) // optional metadata
    .addImpls|addAllImpls(io.substrait.extension.SimpleExtension.ScalarFunctionVariant) // impls elements
    .build();
 

Returns:

A new ScalarFunction builder