AbstractParameterTool (flink-java 1.11.3 API)

java.lang.Object
- org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
- - org.apache.flink.api.java.utils.AbstractParameterTool

所有已实现的接口:

Serializable, Cloneable

直接已知子类:

MultipleParameterTool, ParameterTool
```
@Public
public abstract class AbstractParameterTool
extends org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
implements Serializable, Cloneable
```
This class provides common utility methods of ParameterTool and MultipleParameterTool.

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected static String`	`DEFAULT_UNDEFINED`
`protected Map<String,String>`	`defaultData`
`protected static String`	`NO_VALUE_KEY`
`protected Set<String>`	`unrequestedParameters`

构造器概要

构造器
构造器和说明

AbstractParameterTool()

构造器
构造器和说明
`AbstractParameterTool()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected void`	`addToDefaults(String key, String value)`
`protected abstract Object`	`clone()`
`protected abstract String`	`get(String key)` Returns the String value for the given key.
`String`	`get(String key, String defaultValue)` Returns the String value for the given key.
`boolean`	`getBoolean(String key)` Returns the Boolean value for the given key.
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the Boolean value for the given key.
`byte`	`getByte(String key)` Returns the Byte value for the given key.
`byte`	`getByte(String key, byte defaultValue)` Returns the Byte value for the given key.
`double`	`getDouble(String key)` Returns the Double value for the given key.
`double`	`getDouble(String key, double defaultValue)` Returns the Double value for the given key.
`float`	`getFloat(String key)` Returns the Float value for the given key.
`float`	`getFloat(String key, float defaultValue)` Returns the Float value for the given key.
`int`	`getInt(String key)` Returns the Integer value for the given key.
`int`	`getInt(String key, int defaultValue)` Returns the Integer value for the given key.
`long`	`getLong(String key)` Returns the Long value for the given key.
`long`	`getLong(String key, long defaultValue)` Returns the Long value for the given key.
`protected abstract int`	`getNumberOfParameters()` Returns number of parameters in `AbstractParameterTool`.
`String`	`getRequired(String key)` Returns the String value for the given key.
`short`	`getShort(String key)` Returns the Short value for the given key.
`short`	`getShort(String key, short defaultValue)` Returns the Short value for the given key.
`Set<String>`	`getUnrequestedParameters()` Returns the set of parameter names which have not been requested with `has(String)` or one of the `get` methods.
`abstract boolean`	`has(String value)` Check if value is set.
`abstract Map<String,String>`	`toMap()`

从类继承的方法 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
equals, hashCode

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NO_VALUE_KEY
```
protected static final String NO_VALUE_KEY
```
    另请参阅:
    
    常量字段值
  - DEFAULT_UNDEFINED
```
protected static final String DEFAULT_UNDEFINED
```
    另请参阅:
    
    常量字段值
  - defaultData
```
protected transient Map<String,String> defaultData
```
  - unrequestedParameters
```
protected transient Set<String> unrequestedParameters
```
- 构造器详细资料
  - AbstractParameterTool
```
public AbstractParameterTool()
```
- 方法详细资料
  - getUnrequestedParameters
```
@PublicEvolving
public Set<String> getUnrequestedParameters()
```
    Returns the set of parameter names which have not been requested with has(String) or one of the get methods. Access to the map returned by toMap() is not tracked.
  - getNumberOfParameters
```
protected abstract int getNumberOfParameters()
```
    Returns number of parameters in AbstractParameterTool.
  - get
```
protected abstract String get(String key)
```
    Returns the String value for the given key. If the key does not exist it will return null.
  - has
```
public abstract boolean has(String value)
```
    Check if value is set.
  - getRequired
```
public String getRequired(String key)
```
    Returns the String value for the given key. If the key does not exist it will throw a RuntimeException.
  - get
```
public String get(String key,
                  String defaultValue)
```
    Returns the String value for the given key. If the key does not exist it will return the given default value.
  - getInt
```
public int getInt(String key)
```
    Returns the Integer value for the given key. The method fails if the key does not exist or the value is not an Integer.
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Returns the Integer value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not an Integer.
  - getLong
```
public long getLong(String key)
```
    Returns the Long value for the given key. The method fails if the key does not exist.
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Returns the Long value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Long.
  - getFloat
```
public float getFloat(String key)
```
    Returns the Float value for the given key. The method fails if the key does not exist.
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Returns the Float value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Float.
  - getDouble
```
public double getDouble(String key)
```
    Returns the Double value for the given key. The method fails if the key does not exist.
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Returns the Double value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Double.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the Boolean value for the given key. The method fails if the key does not exist.
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Returns the Boolean value for the given key. If the key does not exists it will return the default value given. The method returns whether the string of the value is "true" ignoring cases.
  - getShort
```
public short getShort(String key)
```
    Returns the Short value for the given key. The method fails if the key does not exist.
  - getShort
```
public short getShort(String key,
                      short defaultValue)
```
    Returns the Short value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Short.
  - getByte
```
public byte getByte(String key)
```
    Returns the Byte value for the given key. The method fails if the key does not exist.
  - getByte
```
public byte getByte(String key,
                    byte defaultValue)
```
    Returns the Byte value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Byte.
  - addToDefaults
```
protected void addToDefaults(String key,
                             String value)
```
  - clone
```
protected abstract Object clone()
                         throws CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 Object
    
    抛出:
    
    CloneNotSupportedException
  - toMap
```
public abstract Map<String,String> toMap()
```
    覆盖:
    
    toMap 在类中 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

类 AbstractParameterTool

字段概要

构造器概要

方法概要

从类继承的方法 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

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

字段详细资料

NO_VALUE_KEY

DEFAULT_UNDEFINED

defaultData

unrequestedParameters

构造器详细资料

AbstractParameterTool

方法详细资料

getUnrequestedParameters

getNumberOfParameters

get

has

getRequired

get

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBoolean

getBoolean

getShort

getShort

getByte

getByte

addToDefaults

clone

toMap