org.apache.flink.configuration

Class ConfigOptions.OptionBuilder

java.lang.Object

org.apache.flink.configuration.ConfigOptions.OptionBuilder

Enclosing class:

ConfigOptions

public static final class ConfigOptions.OptionBuilder
extends Object

The option builder is used to create a ConfigOption. It is instantiated via ConfigOptions.key(String).

Method Summary

Modifier and Type	Method and Description
<T> ConfigOption<T>	defaultValue(T value) Creates a ConfigOption with the given default value.
ConfigOption<String>	noDefaultValue() Creates a string-valued option with no default value.

Methods inherited from class java.lang.Object

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

Method Detail

defaultValue

public <T> ConfigOption<T> defaultValue(T value)

Creates a ConfigOption with the given default value.

This method does not accept "null". For options with no default value, choose one of the noDefaultValue methods.

Type Parameters:

T - The type of the default value.

Parameters:

value - The default value for the config option

Returns:

The config option with the default value.

noDefaultValue

public ConfigOption<String> noDefaultValue()

Creates a string-valued option with no default value. String-valued options are the only ones that can have no default value.

Returns:

The created ConfigOption.