org.apache.flink.table.factories

Class FactoryUtil.FactoryHelper<F extends Factory>

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.FactoryHelper<F>

Direct Known Subclasses:

FactoryUtil.CatalogFactoryHelper, FactoryUtil.ModuleFactoryHelper, FactoryUtil.TableFactoryHelper, SqlGatewayEndpointFactoryUtils.EndpointFactoryHelper

Enclosing class:

FactoryUtil

@PublicEvolving
public static class FactoryUtil.FactoryHelper<F extends Factory>
extends Object

Base helper utility for validating all options for a Factory.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	allOptions
protected Set<String>	consumedOptionKeys
protected Set<String>	deprecatedOptionKeys
protected F	factory

Constructor Summary

Constructors

Constructor and Description
FactoryHelper(F factory, Map<String,String> configuration, ConfigOption<?>... implicitOptions)

Method Summary

Modifier and Type	Method and Description
ReadableConfig	getOptions() Returns all options currently being consumed by the factory.
void	validate() Validates the options of the factory.
void	validateExcept(String... prefixesToSkip) Validates the options of the factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

factory

protected final F extends Factory factory

allOptions

protected final Configuration allOptions

consumedOptionKeys

protected final Set<String> consumedOptionKeys

deprecatedOptionKeys

protected final Set<String> deprecatedOptionKeys

Constructor Detail

FactoryHelper

public FactoryHelper(F factory,
                     Map<String,String> configuration,
                     ConfigOption<?>... implicitOptions)

Method Detail

validate

public void validate()

Validates the options of the factory. It checks for unconsumed option keys.

validateExcept

public void validateExcept(String... prefixesToSkip)

Validates the options of the factory. It checks for unconsumed option keys while ignoring the options with given prefixes.

The option keys that have given prefix prefixToSkip would just be skipped for validation.

Parameters:

prefixesToSkip - Set of option key prefixes to skip validation

getOptions

public ReadableConfig getOptions()

Returns all options currently being consumed by the factory.