Package org.apache.flink.configuration

Class UnmodifiableConfiguration

java.lang.Object

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

org.apache.flink.configuration.Configuration

org.apache.flink.configuration.UnmodifiableConfiguration

All Implemented Interfaces:

Serializable, Cloneable, ReadableConfig, WritableConfig, IOReadableWritable

@Public
public class UnmodifiableConfiguration
extends Configuration

Unmodifiable version of the Configuration class.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.configuration.Configuration

confData

Constructor Summary

Constructors

Constructor	Description
UnmodifiableConfiguration(Configuration config)	Creates a new UnmodifiableConfiguration, which holds a copy of the given configuration that cannot be altered.

Method Summary

Modifier and Type	Method	Description
void	addAll(Configuration other)
void	addAll(Configuration other, String prefix)	Adds all entries from the given configuration into this configuration.
void	addAllToProperties(Properties props)	Adds all entries in this Configuration to the given Properties.
<T> boolean	removeConfig(ConfigOption<T> configOption)	Removes given config option from the configuration.

Methods inherited from class org.apache.flink.configuration.Configuration

clone, contains, containsKey, equals, fromMap, get, get, getBytes, getEnum, getOptional, getString, getValue, hashCode, keySet, read, removeKey, set, setBytes, setString, toFileWritableMap, toMap, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

UnmodifiableConfiguration

public UnmodifiableConfiguration(Configuration config)

Creates a new UnmodifiableConfiguration, which holds a copy of the given configuration that cannot be altered.

Parameters:

config - The configuration with the original contents.

Method Detail

addAllToProperties

public void addAllToProperties(Properties props)

Description copied from class: Configuration

Adds all entries in this Configuration to the given Properties.

Overrides:

addAllToProperties in class Configuration

addAll

public final void addAll(Configuration other)

Overrides:

addAll in class Configuration

addAll

public final void addAll(Configuration other,
                         String prefix)

Description copied from class: Configuration

Adds all entries from the given configuration into this configuration. The keys are prepended with the given prefix.

Overrides:

addAll in class Configuration

Parameters:

other - The configuration whose entries are added to this configuration.

prefix - The prefix to prepend.

removeConfig

public <T> boolean removeConfig(ConfigOption<T> configOption)

Description copied from class: Configuration

Removes given config option from the configuration.

Overrides:

removeConfig in class Configuration

Type Parameters:

T - Type of the config option

Parameters:

configOption - config option to remove

Returns:

true is config has been removed, false otherwise