Configuration (flink-core 1.0.1 API)

java.lang.Object
- org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
- - org.apache.flink.configuration.Configuration

All Implemented Interfaces:

Serializable, Cloneable, IOReadableWritable

Direct Known Subclasses:

UnmodifiableConfiguration
```
@Public
public class Configuration
extends ExecutionConfig.GlobalJobParameters
implements IOReadableWritable, Serializable, Cloneable
```
Lightweight configuration object which stores key/value pairs.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Configuration()` Creates a new empty configuration.
`Configuration(Configuration other)` Creates a new configuration with the copy of the given configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAll(Configuration other)`
`void`	`addAll(Configuration other, String prefix)` Adds all entries from the given configuration into this configuration.
`Configuration`	`clone()`
`boolean`	`containsKey(String key)` Checks whether there is an entry with the specified key
`boolean`	`equals(Object obj)`
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the value associated with the given key as a boolean.
`byte[]`	`getBytes(String key, byte[] defaultValue)` Returns the value associated with the given key as a byte array.
`<T> Class<T>`	`getClass(String key, Class<? extends T> defaultValue, ClassLoader classLoader)` Returns the class associated with the given key as a string.
`double`	`getDouble(String key, double defaultValue)` Returns the value associated with the given key as a double.
`float`	`getFloat(String key, float defaultValue)` Returns the value associated with the given key as a float.
`int`	`getInteger(String key, int defaultValue)` Returns the value associated with the given key as an integer.
`long`	`getLong(String key, long defaultValue)` Returns the value associated with the given key as a long.
`String`	`getString(String key, String defaultValue)` Returns the value associated with the given key as a string.
`int`	`hashCode()`
`Set<String>`	`keySet()` Returns the keys of all key/value pairs stored inside this configuration object.
`void`	`read(DataInputView in)` Reads the object's internal data from the given data input view.
`void`	`setBoolean(String key, boolean value)` Adds the given key/value pair to the configuration object.
`void`	`setBytes(String key, byte[] bytes)` Adds the given byte array to the configuration object.
`void`	`setClass(String key, Class<?> klazz)` Adds the given key/value pair to the configuration object.
`void`	`setDouble(String key, double value)` Adds the given key/value pair to the configuration object.
`void`	`setFloat(String key, float value)` Adds the given key/value pair to the configuration object.
`void`	`setInteger(String key, int value)` Adds the given key/value pair to the configuration object.
`void`	`setLong(String key, long value)` Adds the given key/value pair to the configuration object.
`void`	`setString(String key, String value)` Adds the given key/value pair to the configuration object.
`Map<String,String>`	`toMap()` Convert UserConfig into a `Map<String, String>` representation.
`String`	`toString()`
`void`	`write(DataOutputView out)` Writes the object's internal data to the given data output view.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Configuration
```
public Configuration()
```
    Creates a new empty configuration.
  - Configuration
```
public Configuration(Configuration other)
```
    Creates a new configuration with the copy of the given configuration.
    
    Parameters:
    
    other - The configuration to copy the entries from.
- Method Detail
  - getClass
```
public <T> Class<T> getClass(String key,
                             Class<? extends T> defaultValue,
                             ClassLoader classLoader)
                      throws ClassNotFoundException
```
    Returns the class associated with the given key as a string.
    
    Type Parameters:
    
    T - The type of the class to return.
    
    Parameters:
    
    key - The key pointing to the associated value
    
    defaultValue - The optional default value returned if no entry exists
    
    classLoader - The class loader used to resolve the class.
    
    Returns:
    
    The value associated with the given key, or the default value, if to entry for the key exists.
    
    Throws:
    
    ClassNotFoundException
  - setClass
```
public void setClass(String key,
                     Class<?> klazz)
```
    Adds the given key/value pair to the configuration object. The class can be retrieved by invoking getClass(String, Class, ClassLoader) if it is in the scope of the class loader on the caller.
    
    Parameters:
    
    key - The key of the pair to be added
    
    klazz - The value of the pair to be added
    
    See Also:
    
    getClass(String, Class, ClassLoader)
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Returns the value associated with the given key as a string.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setString
```
public void setString(String key,
                      String value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getInteger
```
public int getInteger(String key,
                      int defaultValue)
```
    Returns the value associated with the given key as an integer.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setInteger
```
public void setInteger(String key,
                       int value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Returns the value associated with the given key as a long.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setLong
```
public void setLong(String key,
                    long value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Returns the value associated with the given key as a boolean.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Returns the value associated with the given key as a float.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setFloat
```
public void setFloat(String key,
                     float value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Returns the value associated with the given key as a double.
    
    Parameters:
    
    key - the key pointing to the associated value
    
    defaultValue - the default value which is returned in case there is no value associated with the given key
    
    Returns:
    
    the (default) value associated with the given key
  - setDouble
```
public void setDouble(String key,
                      double value)
```
    Adds the given key/value pair to the configuration object.
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - getBytes
```
public byte[] getBytes(String key,
                       byte[] defaultValue)
```
    Returns the value associated with the given key as a byte array.
    
    Parameters:
    
    key - The key pointing to the associated value.
    
    defaultValue - The default value which is returned in case there is no value associated with the given key.
    
    Returns:
    
    the (default) value associated with the given key.
  - setBytes
```
public void setBytes(String key,
                     byte[] bytes)
```
    Adds the given byte array to the configuration object. If key is null then nothing is added.
    
    Parameters:
    
    key - The key under which the bytes are added.
    
    bytes - The bytes to be added.
  - keySet
```
public Set<String> keySet()
```
    Returns the keys of all key/value pairs stored inside this configuration object.
    
    Returns:
    
    the keys of all key/value pairs stored inside this configuration object
  - addAll
```
public void addAll(Configuration other)
```
  - addAll
```
public void addAll(Configuration other,
                   String prefix)
```
    Adds all entries from the given configuration into this configuration. The keys are prepended with the given prefix.
    
    Parameters:
    
    other - The configuration whose entries are added to this configuration.
    
    prefix - The prefix to prepend.
  - clone
```
public Configuration clone()
```
    Overrides:
    
    clone in class Object
  - containsKey
```
public boolean containsKey(String key)
```
    Checks whether there is an entry with the specified key
    
    Parameters:
    
    key - key of entry
    
    Returns:
    
    true if the key is stored, false otherwise
  - toMap
```
public Map<String,String> toMap()
```
    Description copied from class: ExecutionConfig.GlobalJobParameters
    
    Convert UserConfig into a Map<String, String> representation. This can be used by the runtime, for example for presenting the user config in the web frontend.
    
    Overrides:
    
    toMap in class ExecutionConfig.GlobalJobParameters
    
    Returns:
    
    Key/Value representation of the UserConfig, or null.
  - read
```
public void read(DataInputView in)
          throws IOException
```
    Description copied from interface: IOReadableWritable
    
    Reads the object's internal data from the given data input view.
    
    Specified by:
    
    read in interface IOReadableWritable
    
    Parameters:
    
    in - the input view to read the data from
    
    Throws:
    
    IOException - thrown if any error occurs while reading from the input stream
  - write
```
public void write(DataOutputView out)
           throws IOException
```
    Description copied from interface: IOReadableWritable
    
    Writes the object's internal data to the given data output view.
    
    Specified by:
    
    write in interface IOReadableWritable
    
    Parameters:
    
    out - the output view to receive the data.
    
    Throws:
    
    IOException - thrown if any error occurs while writing to the output stream
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Configuration

Method Detail

getClass

setClass

getString

setString

getInteger

setInteger

getLong

setLong

getBoolean

setBoolean

getFloat

setFloat

getDouble

setDouble

getBytes

setBytes

keySet

addAll

addAll

clone

containsKey

toMap

read

write

hashCode

equals

toString