org.apache.flink.api.java.utils

Class Option

java.lang.Object

org.apache.flink.api.java.utils.Option

@PublicEvolving
public class Option
extends Object

Internal representation of a parameter passed to a user defined function.

Constructor Summary

Constructors

Constructor and Description
Option(String name)

Method Summary

Modifier and Type	Method and Description
Option	alt(String shortName) Define an alternative / short name of the parameter.
Option	choices(String... choices) Restrict the list of possible values of the parameter.
Option	defaultValue(String defaultValue) Define a default value for the option.
String	getAlt()
Set<String>	getChoices()
String	getDefaultValue()
String	getHelpText()
String	getName()
OptionType	getType()
boolean	hasAlt()
boolean	hasDefaultValue()
boolean	hasType()
Option	help(String helpText) Add a help text, explaining the parameter.
boolean	isCastableToDefinedType(String value)
Option	type(OptionType type) Define the type of the Option.

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

public Option(String name)

Method Detail

alt

public Option alt(String shortName)

Define an alternative / short name of the parameter. Only one alternative per parameter is allowed.

Parameters:

shortName - - short version of the parameter name

Returns:

the updated Option

type

public Option type(OptionType type)

Define the type of the Option.

Parameters:

type - - the type which the the value of the Option can be casted to.

Returns:

the updated Option

defaultValue

public Option defaultValue(String defaultValue)
                    throws RequiredParametersException

Define a default value for the option. Throws an exception if the list of possible values for the parameter is not empty and the default value passed is not in the list.

Parameters:

defaultValue - - the default value

Returns:

the updated Option

Throws:

RequiredParametersException

choices

public Option choices(String... choices)
               throws RequiredParametersException

Restrict the list of possible values of the parameter.

Parameters:

choices - - the allowed values of the parameter.

Returns:

the updated Option

Throws:

RequiredParametersException

help

public Option help(String helpText)

Add a help text, explaining the parameter.

Parameters:

helpText - - the help text.

Returns:

the updated Option

getName

public String getName()

hasAlt

public boolean hasAlt()

hasType

public boolean hasType()

getType

public OptionType getType()

getAlt

public String getAlt()

getHelpText

public String getHelpText()

getChoices

public Set<String> getChoices()

hasDefaultValue

public boolean hasDefaultValue()

getDefaultValue

public String getDefaultValue()

isCastableToDefinedType

public boolean isCastableToDefinedType(String value)