org.apache.flink.api.java.utils

Class ParameterTool

java.lang.Object

org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

org.apache.flink.api.java.utils.ParameterTool

All Implemented Interfaces:

Serializable, Cloneable

public class ParameterTool
extends org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	data
protected static String	DEFAULT_UNDEFINED
protected HashMap<String,String>	defaultData
protected static String	NO_VALUE_KEY

Method Summary

Modifier and Type	Method and Description
protected void	addToDefaults(String key, String value)
protected Object	clone()
void	createPropertiesFile(String pathToFile) Create a properties file with all the known parameters (call after the last get*() call).
void	createPropertiesFile(String pathToFile, boolean overwrite)
static ParameterTool	fromArgs(String[] args)
static ParameterTool	fromMap(Map<String,String> map)
static ParameterTool	fromPropertiesFile(String path)
static ParameterTool	fromSystemProperties()
String	get(String key)
String	get(String key, String defaultValue)
org.apache.flink.configuration.Configuration	getConfiguration()
double	getDouble(String key)
double	getDouble(String key, double defaultValue)
float	getFloat(String key)
float	getFloat(String key, float defaultValue)
int	getInt(String key)
int	getInt(String key, int defaultValue)
long	getLong(String key) Get long value.
long	getLong(String key, long defaultValue)
int	getNumberOfParameters()
Properties	getProperties()
String	getRequired(String key)
boolean	has(String value) Check if value is set
ParameterTool	mergeWith(ParameterTool other)
Map<String,String>	toMap()

Methods inherited from class java.lang.Object

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

Field Detail

NO_VALUE_KEY

protected static String NO_VALUE_KEY

DEFAULT_UNDEFINED

protected static String DEFAULT_UNDEFINED

data

protected final Map<String,String> data

defaultData

protected final HashMap<String,String> defaultData

Method Detail

fromArgs

public static ParameterTool fromArgs(String[] args)

fromPropertiesFile

public static ParameterTool fromPropertiesFile(String path)
                                        throws IOException

Throws:

IOException

fromMap

public static ParameterTool fromMap(Map<String,String> map)

fromSystemProperties

public static ParameterTool fromSystemProperties()

getNumberOfParameters

public int getNumberOfParameters()

get

public String get(String key)

getRequired

public String getRequired(String key)

get

public String get(String key,
                  String defaultValue)

has

public boolean has(String value)

Check if value is set

getInt

public int getInt(String key)

getInt

public int getInt(String key,
                  int defaultValue)

getLong

public long getLong(String key)

Get long value. The method fails if the key is not specified.

Parameters:

key - Name of the key

Returns:

getLong

public long getLong(String key,
                    long defaultValue)

getFloat

public float getFloat(String key)

getFloat

public float getFloat(String key,
                      float defaultValue)

getDouble

public double getDouble(String key)

getDouble

public double getDouble(String key,
                        double defaultValue)

addToDefaults

protected void addToDefaults(String key,
                             String value)

getConfiguration

public org.apache.flink.configuration.Configuration getConfiguration()

getProperties

public Properties getProperties()

createPropertiesFile

public void createPropertiesFile(String pathToFile)
                          throws IOException

Create a properties file with all the known parameters (call after the last get*() call). Set the default value, if available. Use this method to create a properties file skeleton.

Parameters:

pathToFile - Location of the default properties file.

Throws:

IOException

createPropertiesFile

public void createPropertiesFile(String pathToFile,
                                 boolean overwrite)
                          throws IOException

Throws:

IOException

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

mergeWith

public ParameterTool mergeWith(ParameterTool other)

toMap

public Map<String,String> toMap()

Overrides:

toMap in class org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters