org.apache.reef.tang.formats

Class ConfigurationModule

java.lang.Object

org.apache.reef.tang.formats.ConfigurationModule

public class ConfigurationModule
extends Object

Allows applications to bundle sets of configuration options together into discrete packages. Unlike more conventional approaches, ConfigurationModules store such information in static data structures that can be statically discovered and sanity-checked.

See Also:

for more information and examples.

Method Summary

Methods

Modifier and Type	Method and Description
void	assertStaticClean()
Configuration	build()
Set<NamedParameterNode<?>>	getBoundNamedParameters()
<T> ConfigurationModule	set(Impl<List> opt, List implList) Binds a list to a specific optional/required Impl using ConfigurationModule.
<T> ConfigurationModule	set(Impl<T> opt, Class<? extends T> impl)
<T> ConfigurationModule	set(Impl<T> opt, String impl)
ConfigurationModule	set(Param<? extends Number> opt, Number val)
ConfigurationModule	set(Param<Boolean> opt, boolean val)
<T> ConfigurationModule	set(Param<List> opt, List implList) Binds a list to a specfici optional/required Param using ConfigurationModule.
<T> ConfigurationModule	set(Param<T> opt, Class<? extends T> val)
<T> ConfigurationModule	set(Param<T> opt, String val)
String	toPrettyString()
List<Map.Entry<String,String>>	toStringPairs()

Methods inherited from class java.lang.Object

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

Method Detail

set

public final <T> ConfigurationModule set(Impl<T> opt,
                          Class<? extends T> impl)

set

public final <T> ConfigurationModule set(Impl<T> opt,
                          String impl)

set

public final <T> ConfigurationModule set(Impl<List> opt,
                          List implList)

Binds a list to a specific optional/required Impl using ConfigurationModule.

Type Parameters:

T -

Parameters:

opt - Target optional/required Impl

implList - List object to be injected

Returns:

set

public final <T> ConfigurationModule set(Param<T> opt,
                          Class<? extends T> val)

set

public final ConfigurationModule set(Param<Boolean> opt,
                      boolean val)

set

public final ConfigurationModule set(Param<? extends Number> opt,
                      Number val)

set

public final <T> ConfigurationModule set(Param<T> opt,
                          String val)

set

public final <T> ConfigurationModule set(Param<List> opt,
                          List implList)

Binds a list to a specfici optional/required Param using ConfigurationModule.

Type Parameters:

T -

Parameters:

opt - target optional/required Param

implList - List object to be injected

Returns:

build

public Configuration build()
                    throws BindException

Throws:

BindException

getBoundNamedParameters

public Set<NamedParameterNode<?>> getBoundNamedParameters()

toStringPairs

public List<Map.Entry<String,String>> toStringPairs()

toPrettyString

public String toPrettyString()

assertStaticClean

public void assertStaticClean()
                       throws ClassHierarchyException

Throws:

ClassHierarchyException