org.apache.flink.table.planner.plan.rules.logical

Class ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig

java.lang.Object

org.apache.flink.table.planner.plan.rules.logical.ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig

All Implemented Interfaces:

org.apache.calcite.plan.RelRule.Config, LogicalUnnestRule.LogicalUnnestRuleConfig

Enclosing class:

ImmutableLogicalUnnestRule

@Immutable
 @CheckReturnValue
public static final class ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig
extends Object
implements LogicalUnnestRule.LogicalUnnestRuleConfig

Immutable implementation of LogicalUnnestRule.LogicalUnnestRuleConfig.

Use the builder to create immutable instances: ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig.Builder Builds instances of type LogicalUnnestRuleConfig.

Field Summary

Fields inherited from interface org.apache.flink.table.planner.plan.rules.logical.LogicalUnnestRule.LogicalUnnestRuleConfig

DEFAULT

Method Summary

Modifier and Type	Method and Description
static ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig.Builder	builder() Creates a builder for LogicalUnnestRuleConfig.
static ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig	copyOf(LogicalUnnestRule.LogicalUnnestRuleConfig instance) Creates an immutable copy of a LogicalUnnestRule.LogicalUnnestRuleConfig value.
String	description()
boolean	equals(Object another) This instance is equal to all instances of LogicalUnnestRuleConfig that have equal attribute values.
int	hashCode() Computes a hash code from attributes: relBuilderFactory, description, operandSupplier.
org.apache.calcite.plan.RelRule.OperandTransform	operandSupplier()
org.apache.calcite.tools.RelBuilderFactory	relBuilderFactory()
String	toString() Prints the immutable value LogicalUnnestRuleConfig with attribute values.
ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig	withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform value) Copy the current immutable object by setting a value for the operandSupplier attribute.
ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig	withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory value) Copy the current immutable object by setting a value for the relBuilderFactory attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.planner.plan.rules.logical.LogicalUnnestRule.LogicalUnnestRuleConfig

toRule

Methods inherited from interface org.apache.calcite.plan.RelRule.Config

as

Method Detail

relBuilderFactory

public org.apache.calcite.tools.RelBuilderFactory relBuilderFactory()

Specified by:

relBuilderFactory in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the relBuilderFactory attribute

description

@Nullable
public String description()

Specified by:

description in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the description attribute

operandSupplier

public org.apache.calcite.plan.RelRule.OperandTransform operandSupplier()

Specified by:

operandSupplier in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the operandSupplier attribute

withRelBuilderFactory

public final ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory value)

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

Specified by:

withRelBuilderFactory in interface org.apache.calcite.plan.RelRule.Config

Parameters:

value - A new value for relBuilderFactory

Returns:

A modified copy of the this object

withDescription

public final ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig 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.

Specified by:

withDescription in interface org.apache.calcite.plan.RelRule.Config

Parameters:

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

Returns:

A modified copy of the this object

withOperandSupplier

public final ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform value)

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

Specified by:

withOperandSupplier in interface org.apache.calcite.plan.RelRule.Config

Parameters:

value - A new value for operandSupplier

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of LogicalUnnestRuleConfig 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: relBuilderFactory, description, operandSupplier.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value LogicalUnnestRuleConfig with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig copyOf(LogicalUnnestRule.LogicalUnnestRuleConfig instance)

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

builder

public static ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig.Builder builder()

Creates a builder for LogicalUnnestRuleConfig.

 ImmutableLogicalUnnestRule.LogicalUnnestRuleConfig.builder()
    .relBuilderFactory(org.apache.calcite.tools.RelBuilderFactory) // optional relBuilderFactory
    .description(String | null) // nullable description
    .operandSupplier(org.apache.calcite.plan.RelRule.OperandTransform) // optional operandSupplier
    .build();
 

Returns:

A new LogicalUnnestRuleConfig builder