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

Class ImmutablePushProjectIntoTableSourceScanRule.Config

java.lang.Object

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

All Implemented Interfaces:

org.apache.calcite.plan.RelRule.Config, PushProjectIntoTableSourceScanRule.Config

Enclosing class:

ImmutablePushProjectIntoTableSourceScanRule

@Immutable
 @CheckReturnValue
public static final class ImmutablePushProjectIntoTableSourceScanRule.Config
extends Object
implements PushProjectIntoTableSourceScanRule.Config

Immutable implementation of PushProjectIntoTableSourceScanRule.Config.

Use the builder to create immutable instances: ImmutablePushProjectIntoTableSourceScanRule.Config.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutablePushProjectIntoTableSourceScanRule.Config.Builder Builds instances of type Config.

Field Summary

Fields inherited from interface org.apache.flink.table.planner.plan.rules.logical.PushProjectIntoTableSourceScanRule.Config

DEFAULT

Method Summary

Modifier and Type	Method and Description
static ImmutablePushProjectIntoTableSourceScanRule.Config.Builder	builder() Creates a builder for Config.
static ImmutablePushProjectIntoTableSourceScanRule.Config	copyOf(PushProjectIntoTableSourceScanRule.Config instance) Creates an immutable copy of a PushProjectIntoTableSourceScanRule.Config value.
String	description()
boolean	equals(Object another) This instance is equal to all instances of Config 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 Config with attribute values.
ImmutablePushProjectIntoTableSourceScanRule.Config	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
ImmutablePushProjectIntoTableSourceScanRule.Config	withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform value) Copy the current immutable object by setting a value for the operandSupplier attribute.
ImmutablePushProjectIntoTableSourceScanRule.Config	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.PushProjectIntoTableSourceScanRule.Config

onProjectedScan, 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 ImmutablePushProjectIntoTableSourceScanRule.Config 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 ImmutablePushProjectIntoTableSourceScanRule.Config 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 ImmutablePushProjectIntoTableSourceScanRule.Config 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 Config 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 Config with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePushProjectIntoTableSourceScanRule.Config copyOf(PushProjectIntoTableSourceScanRule.Config instance)

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

builder

public static ImmutablePushProjectIntoTableSourceScanRule.Config.Builder builder()

Creates a builder for Config.

 ImmutablePushProjectIntoTableSourceScanRule.Config.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 Config builder