org.apache.flink.api.java.utils

类 MultipleParameterTool

java.lang.Object

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

org.apache.flink.api.java.utils.AbstractParameterTool

org.apache.flink.api.java.utils.MultipleParameterTool

所有已实现的接口:

Serializable, Cloneable

@PublicEvolving
public class MultipleParameterTool
extends AbstractParameterTool

This class provides simple utility methods for reading and parsing program arguments from different sources. Multiple values parameter in args could be supported. For example, --multi multiValue1 --multi multiValue2. If MultipleParameterTool object is used for GlobalJobParameters, the last one of multiple values will be used. Navigate to toMap() for more information.

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected Map<String,Collection<String>>	data

从类继承的字段 org.apache.flink.api.java.utils.AbstractParameterTool

DEFAULT_UNDEFINED, defaultData, NO_VALUE_KEY, unrequestedParameters

方法概要

限定符和类型	方法和说明
protected Object	clone()
boolean	equals(Object o)
static MultipleParameterTool	fromArgs(String[] args) Returns MultipleParameterTool for the given arguments.
static MultipleParameterTool	fromMultiMap(Map<String,Collection<String>> multiMap) Returns MultipleParameterTool for the given multi map.
String	get(String key) Returns the String value for the given key.
Collection<String>	getMultiParameter(String key) Returns the Collection of String values for the given key.
Collection<String>	getMultiParameterRequired(String key) Returns the Collection of String values for the given key.
int	getNumberOfParameters() Returns number of parameters in ParameterTool.
boolean	has(String value) Check if value is set.
int	hashCode()
MultipleParameterTool	mergeWith(MultipleParameterTool other) Merges two MultipleParameterTool.
Map<String,String>	toMap()
Map<String,Collection<String>>	toMultiMap() Return MultiMap of all the parameters processed by MultipleParameterTool.

从类继承的方法 org.apache.flink.api.java.utils.AbstractParameterTool

addToDefaults, get, getBoolean, getBoolean, getByte, getByte, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRequired, getShort, getShort, getUnrequestedParameters

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

字段详细资料

data

protected final Map<String,Collection<String>> data

方法详细资料

fromArgs

public static MultipleParameterTool fromArgs(String[] args)

Returns MultipleParameterTool for the given arguments. The arguments are keys followed by values. Keys have to start with '-' or '--'

Example arguments: --key1 value1 --key2 value2 -key3 value3 --multi multiValue1 --multi multiValue2

参数:

args - Input array arguments

返回:

A MultipleParameterTool

fromMultiMap

public static MultipleParameterTool fromMultiMap(Map<String,Collection<String>> multiMap)

Returns MultipleParameterTool for the given multi map.

参数:

multiMap - A map of arguments. Key is String and value is a Collection.

返回:

A MultipleParameterTool

equals

public boolean equals(Object o)

覆盖:

equals 在类中 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

hashCode

public int hashCode()

覆盖:

hashCode 在类中 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

getNumberOfParameters

public int getNumberOfParameters()

Returns number of parameters in ParameterTool.

指定者:

getNumberOfParameters 在类中 AbstractParameterTool

get

public String get(String key)

Returns the String value for the given key. The value should only have one item. Use getMultiParameter(String) instead if want to get multiple values parameter. If the key does not exist it will return null.

指定者:

get 在类中 AbstractParameterTool

has

public boolean has(String value)

Check if value is set.

指定者:

has 在类中 AbstractParameterTool

getMultiParameter

public Collection<String> getMultiParameter(String key)

Returns the Collection of String values for the given key. If the key does not exist it will return null.

getMultiParameterRequired

public Collection<String> getMultiParameterRequired(String key)

Returns the Collection of String values for the given key. If the key does not exist it will throw a RuntimeException.

toMultiMap

public Map<String,Collection<String>> toMultiMap()

Return MultiMap of all the parameters processed by MultipleParameterTool.

返回:

MultiMap of the MultipleParameterTool. Key is String and Value is a Collection of String.

clone

protected Object clone()
                throws CloneNotSupportedException

指定者:

clone 在类中 AbstractParameterTool

抛出:

CloneNotSupportedException

mergeWith

public MultipleParameterTool mergeWith(MultipleParameterTool other)

Merges two MultipleParameterTool.

参数:

other - Other MultipleParameterTool object

返回:

The Merged MultipleParameterTool

toMap

public Map<String,String> toMap()

指定者:

toMap 在类中 AbstractParameterTool