org.apache.reef.tang.implementation

Class ConfigurationBuilderImpl

java.lang.Object

org.apache.reef.tang.implementation.ConfigurationBuilderImpl

All Implemented Interfaces:

ConfigurationBuilder

Direct Known Subclasses:

JavaConfigurationBuilderImpl

public class ConfigurationBuilderImpl
extends Object
implements ConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMPORT
static String	INIT

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguration(Configuration conf) Add all configuration parameters from the given Configuration object.
void	bind(Node key, Node value) Bind classes to each other, based on their full class names; alternatively, bound a NamedParameter configuration option to a configuration value.
<T> void	bind(String key, String value) Bind classes to each other, based on their full class names; alternatively, bound a NamedParameter configuration option to a configuration value.
<T> void	bindConstructor(ClassNode<T> k, ClassNode<? extends ExternalConstructor<? extends T>> v) Register an ExternalConstructor implementation with Tang.
<T> void	bindImplementation(ClassNode<T> n, ClassNode<? extends T> m)
<T> void	bindList(NamedParameterNode<List<T>> iface, List implList) Bind an list of implementations(Class or String) to an given NamedParameter.
void	bindList(String iface, List implList)
<T> void	bindParameter(NamedParameterNode<T> name, String value)
<T> void	bindSetEntry(NamedParameterNode<Set<T>> iface, Node impl)
<T> void	bindSetEntry(NamedParameterNode<Set<T>> iface, String impl)
void	bindSetEntry(String iface, Node impl)
void	bindSetEntry(String iface, String impl)
ConfigurationImpl	build() Produce an immutable Configuration object that contains the current bindings and ClassHierarchy of this ConfigurationBuilder.
String	classPrettyDefaultString(String longName) Pretty print the default implementation / value of the provided class / NamedParameter.
String	classPrettyDescriptionString(String fullName) Pretty print the human readable documentation of the provided class / NamedParameter.
boolean	equals(Object o)
ClassHierarchy	getClassHierarchy() Each ConfigurationBuilder instance is associated with a ClassHierarchy.
int	hashCode()
void	registerLegacyConstructor(ClassNode<?> cn, ClassNode<?>... args) Force Tang to treat the specified constructor as though it had an @Inject annotation.
void	registerLegacyConstructor(ClassNode<?> c, ConstructorArg... args) Force Tang to treat the specified constructor as though it had an @Inject annotation.
void	registerLegacyConstructor(String s, String... args) Force Tang to treat the specified constructor as though it had an @Inject annotation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

IMPORT

public static final String IMPORT

See Also:

Constant Field Values

INIT

public static final String INIT

See Also:

Constant Field Values

Method Detail

addConfiguration

public void addConfiguration(Configuration conf)
                      throws BindException

Description copied from interface: ConfigurationBuilder

Add all configuration parameters from the given Configuration object.

Specified by:

addConfiguration in interface ConfigurationBuilder

Parameters:

conf - the configuration to be added

Throws:

BindException

getClassHierarchy

public ClassHierarchy getClassHierarchy()

Description copied from interface: ConfigurationBuilder

Each ConfigurationBuilder instance is associated with a ClassHierarchy. It uses this ClassHierarchy to validate the configuration options that it processes.

Specified by:

getClassHierarchy in interface ConfigurationBuilder

Returns:

a reference to the ClassHierarchy instance backing this ConfigurationBuilder. No copy is made, since ClassHierarchy objects are effectively immutable.

registerLegacyConstructor

public void registerLegacyConstructor(ClassNode<?> c,
                             ConstructorArg... args)
                               throws BindException

Description copied from interface: ConfigurationBuilder

Force Tang to treat the specified constructor as though it had an @Inject annotation.

This method takes ClassNode and ConstructorArg objects. Like all of the methods in this API, these objects must come from the ClassHierarchy instance returned by getClassHierarchy().

Specified by:

registerLegacyConstructor in interface ConfigurationBuilder

Parameters:

c - The class the constructor instantiates.

args - The parsed ConstructorArg objects corresponding to the types of the arguments taken by the constructor, in declaration order.

Throws:

BindException - if the constructor does not exist, or if it has already been bound as a legacy constructor.

registerLegacyConstructor

public void registerLegacyConstructor(String s,
                             String... args)
                               throws BindException

Description copied from interface: ConfigurationBuilder

Force Tang to treat the specified constructor as though it had an @Inject annotation.

Specified by:

registerLegacyConstructor in interface ConfigurationBuilder

Parameters:

s - The full name of the class the constructor instantiates.

args - The full names of the types of the arguments taken by the constructor, in declaration order.

Throws:

BindException - if the constructor does not exist, or if it has already been bound as a legacy constructor.

registerLegacyConstructor

public void registerLegacyConstructor(ClassNode<?> cn,
                             ClassNode<?>... args)
                               throws BindException

Description copied from interface: ConfigurationBuilder

Force Tang to treat the specified constructor as though it had an @Inject annotation.

This method takes ClassNode objects. Like all of the methods in this API, the ClassNode objects must come from the ClassHierarchy instance returned by getClassHierarchy().

Specified by:

registerLegacyConstructor in interface ConfigurationBuilder

Parameters:

cn - The class the constructor instantiates.

args - The types of the arguments taken by the constructor, in declaration order.

Throws:

BindException - if the constructor does not exist, or if it has already been bound as a legacy constructor.

bind

public <T> void bind(String key,
            String value)
          throws BindException

Description copied from interface: ConfigurationBuilder

Bind classes to each other, based on their full class names; alternatively, bound a NamedParameter configuration option to a configuration value.

Specified by:

bind in interface ConfigurationBuilder

Type Parameters:

T - a type

Parameters:

key - The full name of the interface that should resolve to impl, or the NamedParameter to be set.

value - The full name of the implementation that will be used in place of impl, or the value the NamedParameter should be set to.

Throws:

BindException - If (In the case of interfaces and implementations) the underlying ClassHierarchy does not recognise iface and impl as known, valid classes, or if impl is not a in implementation of iface, or (in the case of NamedParameters and values) if iface is not a NamedParameter, or if impl fails to parse as the type the iface expects.

bind

public void bind(Node key,
        Node value)
          throws BindException

Description copied from interface: ConfigurationBuilder

Bind classes to each other, based on their full class names; alternatively, bound a NamedParameter configuration option to a configuration value.

This method takes Node objects. Like all of the methods in this API, these objects must come from the ClassHierarchy instance returned by getClassHierarchy().

Specified by:

bind in interface ConfigurationBuilder

Parameters:

key - The interface / NamedParameter to be bound.

value - The implementation / value iface should be set to.

Throws:

BindException - if there is a type checking error See bind(String,String) for a more complete description.

bindImplementation

public <T> void bindImplementation(ClassNode<T> n,
                          ClassNode<? extends T> m)
                        throws BindException

Throws:

BindException

bindParameter

public <T> void bindParameter(NamedParameterNode<T> name,
                     String value)
                   throws BindException

Throws:

BindException

bindSetEntry

public void bindSetEntry(String iface,
                String impl)
                  throws BindException

Specified by:

bindSetEntry in interface ConfigurationBuilder

Throws:

BindException

bindSetEntry

public void bindSetEntry(String iface,
                Node impl)
                  throws BindException

Specified by:

bindSetEntry in interface ConfigurationBuilder

Throws:

BindException

bindSetEntry

public <T> void bindSetEntry(NamedParameterNode<Set<T>> iface,
                    String impl)
                  throws BindException

Specified by:

bindSetEntry in interface ConfigurationBuilder

Throws:

BindException

bindSetEntry

public <T> void bindSetEntry(NamedParameterNode<Set<T>> iface,
                    Node impl)
                  throws BindException

Specified by:

bindSetEntry in interface ConfigurationBuilder

Throws:

BindException

bindList

public <T> void bindList(NamedParameterNode<List<T>> iface,
                List implList)

Description copied from interface: ConfigurationBuilder

Bind an list of implementations(Class or String) to an given NamedParameter. Unlike bindSetEntry, bindListEntry will bind a whole list to the parameter, not an element of the list.

Since ordering of the list is important, list binding cannot be repeated or merged unlike set binding. If the elements of the list are Classes, the objects created by the Classes will be injected. If the elements are Strings, the values will be injected directly to a given list parameter.

Specified by:

bindList in interface ConfigurationBuilder

Type Parameters:

T - a type

Parameters:

iface - The list named parameter to be instantiated

implList - The list of class or value will be used to instantiated the named parameter

bindList

public void bindList(String iface,
            List implList)

Specified by:

bindList in interface ConfigurationBuilder

bindConstructor

public <T> void bindConstructor(ClassNode<T> k,
                       ClassNode<? extends ExternalConstructor<? extends T>> v)

Description copied from interface: ConfigurationBuilder

Register an ExternalConstructor implementation with Tang. ExternalConstructors are proxy classes that instantiate some other class. They have two primary use cases: (1) adding new constructors to classes that you cannot modify and (2) implementing constructors that examine their arguments and return an instance of a subclass of the requested object.

To see how the second use case could be useful, consider a implementing a URI interface with a distinct subclass for each valid URI prefix (e.g., http://, ssh://, etc...). An ExternalConstructor could examine the prefix and delegate to a constructor of the correct implementation (e.g, HttpURL, SshURL, etc...) which would validate the remainder of the provided string. URI's external constructor would return the validated subclass of URI that corresponds to the provided string, allowing instanceof and downcasts to behave as expected in the code that invoked Tang.

Both use cases should be avoided when possible, since they can unnecessarily complicate object injections and undermine Tang's ability to statically check a given configuration.

This method takes ClassNode objects. Like all of the methods in this API, these objects must come from the ClassHierarchy instance returned by getClassHierarchy().

Specified by:

bindConstructor in interface ConfigurationBuilder

Type Parameters:

T - a type

Parameters:

k - The class or interface to be instantiated.

v - The ExternalConstructor class that will be used to instantiate iface.

build

public ConfigurationImpl build()

Description copied from interface: ConfigurationBuilder

Produce an immutable Configuration object that contains the current bindings and ClassHierarchy of this ConfigurationBuilder. Future changes to this ConfigurationBuilder will not be reflected in the returned Configuration.

Since Tang eagerly checks for configuration errors, this method does not perform any additional validation, and does not throw any checkable exceptions.

Specified by:

build in interface ConfigurationBuilder

Returns:

the Configuration

classPrettyDefaultString

public String classPrettyDefaultString(String longName)
                                throws NameResolutionException

Description copied from interface: ConfigurationBuilder

Pretty print the default implementation / value of the provided class / NamedParameter. This is used by Tang to produce human readable error messages.

Specified by:

classPrettyDefaultString in interface ConfigurationBuilder

Parameters:

longName - a name of class or parameter

Returns:

a pretty-formatted string for class or named parameter

Throws:

NameResolutionException

classPrettyDescriptionString

public String classPrettyDescriptionString(String fullName)
                                    throws NameResolutionException

Description copied from interface: ConfigurationBuilder

Pretty print the human readable documentation of the provided class / NamedParameter. This is used by Tang to produce human readable error messages.

Specified by:

classPrettyDescriptionString in interface ConfigurationBuilder

Parameters:

fullName - a name of class or parameter

Returns:

a pretty-formatted class description string

Throws:

NameResolutionException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object