org.apache.flink.graph.drivers.parameter

Interface Parameter<T>

Type Parameters:

T - parameter value type

All Known Implementing Classes:

BooleanParameter, ChoiceParameter, DoubleParameter, IterationConvergence, LongParameter, SimpleParameter, Simplify, StringParameter

public interface Parameter<T>

Encapsulates the usage and configuration of a command-line parameter.

Method Summary

Modifier and Type	Method and Description
void	configure(ParameterTool parameterTool) Read and parse the parameter value from command-line arguments.
String	getUsage() An informal usage string.
T	getValue() Get the parameter value.
boolean	isHidden() A hidden parameter is parsed from the command-line configuration but is not printed in the usage string.

Method Detail

getUsage

String getUsage()

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 ">".

Returns:

command-line usage string

isHidden

boolean isHidden()

A hidden parameter is parsed from the command-line configuration but is not printed in the usage string. This can be used for power-user options not displayed to the general user.

Returns:

whether this parameter should be hidden from standard usage

configure

void configure(ParameterTool parameterTool)

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

Parameters:

parameterTool - parameter parser

getValue

T getValue()

Get the parameter value.

Returns:

parameter value