org.apache.reef.tang

Class Configurations

java.lang.Object

org.apache.reef.tang.Configurations

public final class Configurations
extends Object

Helper class for Configurations.

Method Summary

Methods

Modifier and Type	Method and Description
static ConfigurationSerializer	getDefaultSerializer() Get the default configuration serializer.
static Configuration	merge(Configuration... configurations) Merge a set of Configurations.
static Configuration	merge(Iterable<Configuration> configurations) Merge a set of Configurations.
static String	toString(Configuration config) Return human-readable representation of the configuration.
static String	toString(Configuration config, boolean prettyPrint) Return human-readable representation of the configuration.

Methods inherited from class java.lang.Object

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

Method Detail

merge

public static Configuration merge(Configuration... configurations)

Merge a set of Configurations.

Parameters:

configurations - the configuration to be merged

Returns:

the merged configuration.

Throws:

BindException - if the merge fails.

merge

public static Configuration merge(Iterable<Configuration> configurations)

Merge a set of Configurations.

Parameters:

configurations - the configuration to be merged

Returns:

the merged configuration.

Throws:

BindException - if the merge fails.

getDefaultSerializer

public static ConfigurationSerializer getDefaultSerializer()

Get the default configuration serializer. Currently it is AvroConfigurationSerializer. Use Tang.toString(...) to produce a human-readable string representation of the config.

Returns:

configuration serializer object.

toString

public static String toString(Configuration config)

Return human-readable representation of the configuration.

Parameters:

config - input configuration.

Returns:

a string that contains human-readable representation of the input configuration.

toString

public static String toString(Configuration config,
              boolean prettyPrint)

Return human-readable representation of the configuration. If prettyPrint is true, try to produce a nicer text layout, if possible.

Parameters:

config - input configuration.

prettyPrint - if true, try to produce a nicer text layout, when possible. Otherwise, use the default options of the serializer. Default value is false as not all serializers and formats support pretty printing.

Returns:

a string that contains human-readable representation of the input configuration.