org.apache.reef.tang

Interface JavaConfigurationBuilder

All Superinterfaces:

ConfigurationBuilder

All Known Implementing Classes:

JavaConfigurationBuilderImpl

public interface JavaConfigurationBuilder
extends ConfigurationBuilder

Convenience methods that extend the ConfigurationBuilder but assume that the underlying ClassHierarchy delegates to the default Java classloader.

In addition to being less verbose, this interface expresses many of Tang's type checks in Java's generic type system. This improves IDE auto-completion. It also allows the errors to be caught at compile time instead of later on in the build process, or at runtime.

See Also:

which pushes additional type checks to class load time. This allows Tint, Tang's static analysis tool, to detect a wide range of runtime configuration errors at build time.

Method Summary

Methods

Modifier and Type	Method and Description
<T> JavaConfigurationBuilder	bind(Class<T> iface, Class<?> impl) Bind named parameters, implementations or external constructors, depending on the types of the classes passed in.
<T> JavaConfigurationBuilder	bindConstructor(Class<T> c, Class<? extends ExternalConstructor<? extends T>> v)
<T> JavaConfigurationBuilder	bindImplementation(Class<T> iface, Class<? extends T> impl) Binds the Class impl as the implementation of the interface iface.
<T> JavaConfigurationBuilder	bindList(Class<? extends Name<List<T>>> iface, List impl) Binds a specific list to a named parameter.
JavaConfigurationBuilder	bindNamedParameter(Class<? extends Name<?>> name, String value) Set the value of a named parameter.
<T> JavaConfigurationBuilder	bindNamedParameter(Class<? extends Name<T>> iface, Class<? extends T> impl)
<T> JavaConfigurationBuilder	bindSetEntry(Class<? extends Name<Set<T>>> iface, Class<? extends T> impl)
<T> JavaConfigurationBuilder	bindSetEntry(Class<? extends Name<Set<T>>> iface, String value)

Methods inherited from interface org.apache.reef.tang.ConfigurationBuilder

addConfiguration, bind, bind, bindConstructor, bindList, bindList, bindSetEntry, bindSetEntry, bindSetEntry, bindSetEntry, build, classPrettyDefaultString, classPrettyDescriptionString, getClassHierarchy, registerLegacyConstructor, registerLegacyConstructor, registerLegacyConstructor

Method Detail

bind

<T> JavaConfigurationBuilder bind(Class<T> iface,
                                Class<?> impl)
                              throws BindException

Bind named parameters, implementations or external constructors, depending on the types of the classes passed in.

Type Parameters:

T - a type

Parameters:

iface - an interface class

impl - an implementation class

Returns:

the configuration builder

Throws:

BindException

bindImplementation

<T> JavaConfigurationBuilder bindImplementation(Class<T> iface,
                                              Class<? extends T> impl)
                                            throws BindException

Binds the Class impl as the implementation of the interface iface.

Type Parameters:

T - a type

Parameters:

iface - an interface class

impl - an implementation class

Returns:

the configuration builder

Throws:

BindException

bindNamedParameter

JavaConfigurationBuilder bindNamedParameter(Class<? extends Name<?>> name,
                                          String value)
                                            throws BindException

Set the value of a named parameter.

Parameters:

name - The dummy class that serves as the name of this parameter.

value - A string representing the value of the parameter. Reef must know how to parse the parameter's type.

Returns:

the configuration builder

Throws:

NameResolutionException - which occurs when name resolution fails

BindException

bindNamedParameter

<T> JavaConfigurationBuilder bindNamedParameter(Class<? extends Name<T>> iface,
                                              Class<? extends T> impl)
                                            throws BindException

Throws:

BindException

bindConstructor

<T> JavaConfigurationBuilder bindConstructor(Class<T> c,
                                           Class<? extends ExternalConstructor<? extends T>> v)
                                         throws BindException

Throws:

BindException

bindSetEntry

<T> JavaConfigurationBuilder bindSetEntry(Class<? extends Name<Set<T>>> iface,
                                        String value)
                                      throws BindException

Throws:

BindException

bindSetEntry

<T> JavaConfigurationBuilder bindSetEntry(Class<? extends Name<Set<T>>> iface,
                                        Class<? extends T> impl)
                                      throws BindException

Throws:

BindException

bindList

<T> JavaConfigurationBuilder bindList(Class<? extends Name<List<T>>> iface,
                                    List impl)
                                  throws BindException

Binds a specific list to a named parameter. List's elements can be string values or class implementations. Their type would be checked in this method. If their types are not applicable to the named parameter, it will make an exception.

Type Parameters:

T - A type

Parameters:

iface - The target named parameter to be injected into

impl - A concrete list

Returns:

the configuration builder

Throws:

BindException - It occurs when iface is not a named parameter or impl is not compatible to bind