org.apache.flink.graph.drivers.parameter

Class StringParameter

java.lang.Object

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

org.apache.flink.graph.drivers.parameter.StringParameter

All Implemented Interfaces:

Parameter<String>

public class StringParameter
extends SimpleParameter<String>

A Parameter storing a String.

Field Summary

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

defaultValue, hasDefaultValue, name, value

Constructor Summary

Constructors

Constructor and Description
StringParameter(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.
StringParameter	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

getUsage, getValue, isHidden

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParameter

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

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