org.apache.flink.graph.drivers.parameter

Class ChoiceParameter

java.lang.Object

org.apache.flink.graph.drivers.parameter.SimpleParameter<String>

org.apache.flink.graph.drivers.parameter.ChoiceParameter

All Implemented Interfaces:

Parameter<String>

public class ChoiceParameter
extends SimpleParameter<String>

A Parameter storing a list of String choices and parsing the user's configured selection.

Field Summary

Fields inherited from class org.apache.flink.graph.drivers.parameter.SimpleParameter

defaultValue, hasDefaultValue, name, value

Constructor Summary

Constructors

Constructor and Description
ChoiceParameter(ParameterizedBase owner, String name) Set the parameter name and add this parameter to the list of parameters stored by owner.

Method Summary

Modifier and Type	Method and Description
ChoiceParameter	addChoices(String... choices) Add additional choices.
ChoiceParameter	addHiddenChoices(String... hiddenChoices) Add additional hidden choices.
void	configure(org.apache.flink.api.java.utils.ParameterTool parameterTool) Read and parse the parameter value from command-line arguments.
String	getUsage() An informal usage string.
ChoiceParameter	setDefaultValue(String defaultValue) Set the default value, used if no value is set by the command-line configuration.
String	toString()

Methods inherited from class org.apache.flink.graph.drivers.parameter.SimpleParameter

getValue, isHidden

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceParameter

public ChoiceParameter(ParameterizedBase owner,
                       String name)

Set the parameter name and add this parameter to the list of parameters stored by owner.

Parameters:

owner - the Parameterized using this Parameter

name - the parameter name

Method Detail

setDefaultValue

public ChoiceParameter setDefaultValue(String defaultValue)

Description copied from class: SimpleParameter

Set the default value, used if no value is set by the command-line configuration.

Overrides:

setDefaultValue in class SimpleParameter<String>

Parameters:

defaultValue - the default value

Returns:

this

addChoices

public ChoiceParameter addChoices(String... choices)

Add additional choices. This function can be called multiple times.

Parameters:

choices - additional choices

Returns:

this

addHiddenChoices

public ChoiceParameter addHiddenChoices(String... hiddenChoices)

Add additional hidden choices. This function can be called multiple times. These choices will not be printed in the usage string.

Parameters:

hiddenChoices - additional hidden choices

Returns:

this

getUsage

public String getUsage()

Description copied from interface: Parameter

An informal usage string. Parameter names are prefixed with "--".

Optional parameters are enclosed by "[" and "]".

Generic values are represented by all-caps with specific values enclosed by "<" and ">".

Specified by:

getUsage in interface Parameter<String>

Overrides:

getUsage in class SimpleParameter<String>

Returns:

command-line usage string

configure

public void configure(org.apache.flink.api.java.utils.ParameterTool parameterTool)

Description copied from interface: Parameter

Read and parse the parameter value from command-line arguments.

Parameters:

parameterTool - parameter parser

toString

public String toString()

Overrides:

toString in class Object