org.apache.flink.table.factories

Class FactoryUtil.TableFactoryHelper

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.TableFactoryHelper

Enclosing class:

FactoryUtil

public static class FactoryUtil.TableFactoryHelper
extends Object

Helper utility for discovering formats and validating all options for a DynamicTableFactory.

See Also:

FactoryUtil.createTableFactoryHelper(DynamicTableFactory, DynamicTableFactory.Context)

Method Summary

Modifier and Type	Method and Description
<I,F extends DecodingFormatFactory<I>> DecodingFormat<I>	discoverDecodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption) Discovers a DecodingFormat of the given type using the given option as factory identifier.
<I,F extends EncodingFormatFactory<I>> EncodingFormat<I>	discoverEncodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption) Discovers a EncodingFormat of the given type using the given option as factory identifier.
<I,F extends DecodingFormatFactory<I>> Optional<DecodingFormat<I>>	discoverOptionalDecodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption) Discovers a DecodingFormat of the given type using the given option (if present) as factory identifier.
<I,F extends EncodingFormatFactory<I>> Optional<EncodingFormat<I>>	discoverOptionalEncodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption) Discovers a EncodingFormat of the given type using the given option (if present) as factory identifier.
ReadableConfig	getOptions() Returns all options of the table.
void	validate() Validates the options of the DynamicTableFactory.
void	validateExcept(String... prefixesToSkip) Validates the options of the DynamicTableFactory.

Methods inherited from class java.lang.Object

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

Method Detail

discoverDecodingFormat

public <I,F extends DecodingFormatFactory<I>> DecodingFormat<I> discoverDecodingFormat(Class<F> formatFactoryClass,
                                                                                       ConfigOption<String> formatOption)

Discovers a DecodingFormat of the given type using the given option as factory identifier.

discoverOptionalDecodingFormat

public <I,F extends DecodingFormatFactory<I>> Optional<DecodingFormat<I>> discoverOptionalDecodingFormat(Class<F> formatFactoryClass,
                                                                                                         ConfigOption<String> formatOption)

Discovers a DecodingFormat of the given type using the given option (if present) as factory identifier.

discoverEncodingFormat

public <I,F extends EncodingFormatFactory<I>> EncodingFormat<I> discoverEncodingFormat(Class<F> formatFactoryClass,
                                                                                       ConfigOption<String> formatOption)

Discovers a EncodingFormat of the given type using the given option as factory identifier.

discoverOptionalEncodingFormat

public <I,F extends EncodingFormatFactory<I>> Optional<EncodingFormat<I>> discoverOptionalEncodingFormat(Class<F> formatFactoryClass,
                                                                                                         ConfigOption<String> formatOption)

Discovers a EncodingFormat of the given type using the given option (if present) as factory identifier.

validate

public void validate()

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

validateExcept

public void validateExcept(String... prefixesToSkip)

Validates the options of the DynamicTableFactory. 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 of the table.