org.apache.flink.graph.drivers.parameter

Class LongParameter

java.lang.Object

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

org.apache.flink.graph.drivers.parameter.LongParameter

All Implemented Interfaces:

Parameter<Long>

public class LongParameter
extends SimpleParameter<Long>

A Parameter storing a Long within min and max bounds (inclusive).

Note that the default value may be outside of these bounds.

Field Summary

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

defaultValue, hasDefaultValue, name, value

Constructor Summary

Constructors

Constructor and Description
LongParameter(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.
LongParameter	setDefaultValue(long defaultValue) Set the default value.
LongParameter	setMaximumValue(long maximumValue) Set the maximum value.
LongParameter	setMinimumValue(long minimumValue) Set the minimum value.
String	toString()

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

getUsage, getValue, isHidden, setDefaultValue

Methods inherited from class java.lang.Object

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

Constructor Detail

LongParameter

public LongParameter(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 LongParameter setDefaultValue(long defaultValue)

Set the default value.

The default may set to any value and is not restricted by setting the minimum or maximum values.

Parameters:

defaultValue - the default value.

Returns:

this

setMinimumValue

public LongParameter setMinimumValue(long minimumValue)

Set the minimum value.

If a maximum value has been set then the minimum value must not be greater than the maximum value.

Parameters:

minimumValue - the minimum value

Returns:

this

setMaximumValue

public LongParameter setMaximumValue(long maximumValue)

Set the maximum value.

If a minimum value has been set then the maximum value must not be less than the minimum value.

Parameters:

maximumValue - the maximum 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