org.apache.flink.graph.drivers.parameter

Class BooleanParameter

java.lang.Object

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

org.apache.flink.graph.drivers.parameter.BooleanParameter

All Implemented Interfaces:

Parameter<Boolean>

public class BooleanParameter
extends SimpleParameter<Boolean>

A Parameter storing a Boolean.

Field Summary

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

defaultValue, hasDefaultValue, name, value

Constructor Summary

Constructors

Constructor and Description
BooleanParameter(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
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.
String	toString()

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

getValue, isHidden, setDefaultValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanParameter

public BooleanParameter(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

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<Boolean>

Overrides:

getUsage in class SimpleParameter<Boolean>

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