org.apache.reef.tang.implementation

Class TangImpl

java.lang.Object

org.apache.reef.tang.implementation.TangImpl

All Implemented Interfaces:

Tang

public class TangImpl
extends Object
implements Tang

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.reef.tang.Tang

Tang.Factory

Constructor Summary

Constructors

Constructor and Description
TangImpl()

Method Summary

Methods

Modifier and Type	Method and Description
JavaClassHierarchy	getDefaultClassHierarchy()
JavaClassHierarchy	getDefaultClassHierarchy(URL[] jars, Class<? extends ExternalConstructor<?>>[] parameterParsers) Get a default class hierarchy.
JavaConfigurationBuilder	newConfigurationBuilder() Create a new empty ConfigurationBuilder that is backed by the default classloader.
JavaConfigurationBuilder	newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parsers) Create an empty JavaConfigurationBuilder that is capable of parsing application-specific configuration values.
ConfigurationBuilder	newConfigurationBuilder(ClassHierarchy ch) Return a new ConfigurationBuilder that is backed by the provided ClassHierarchy object.
JavaConfigurationBuilder	newConfigurationBuilder(Configuration... confs) Merge a set of configurations into a new JavaConfiurationBuilder.
JavaConfigurationBuilder	newConfigurationBuilder(URL... jars) Create a new ConfigurationBuilder that is backed by the default classloader and the provided jars.
JavaConfigurationBuilder	newConfigurationBuilder(URL[] jars, Configuration[] confs, Class<? extends ExternalConstructor<?>>[] parameterParsers) Create a new JavaConfiguration builder that has additional jars, incorporates existing configuration data and / or can parse application-specific types.
Injector	newInjector() Returns an Injector based on an empty Configuration.
Injector	newInjector(Configuration... confs) Returns an Injector for the given Configurations.
Injector	newInjector(Configuration confs) Returns an Injector for the given Configuration.
static void	reset() Only for testing.

Methods inherited from class java.lang.Object

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

Constructor Detail

TangImpl

public TangImpl()

Method Detail

reset

public static void reset()

Only for testing. Deletes Tang's current database of known classes, forcing it to rebuild them over time.

newInjector

public Injector newInjector(Configuration... confs)
                     throws BindException

Description copied from interface: Tang

Returns an Injector for the given Configurations.

Specified by:

newInjector in interface Tang

Parameters:

confs - a configuration

Returns:

an injector

Throws:

BindException - If the confs conflict, a BindException will be thrown.

newConfigurationBuilder

public JavaConfigurationBuilder newConfigurationBuilder()

Description copied from interface: Tang

Create a new empty ConfigurationBuilder that is backed by the default classloader.

Specified by:

newConfigurationBuilder in interface Tang

Returns:

a configuration builder

newConfigurationBuilder

public ConfigurationBuilder newConfigurationBuilder(ClassHierarchy ch)

Description copied from interface: Tang

Return a new ConfigurationBuilder that is backed by the provided ClassHierarchy object.

Specified by:

newConfigurationBuilder in interface Tang

Parameters:

ch - Any valid Tang ClassHierarchy, including ones derived from non-Java application binaries.

Returns:

an instance of ConfigurationBuilder. In Tang's default implementation this returns an instance or JavaConfigurationBuilder if ch is backed by a Java classloader.

newConfigurationBuilder

public JavaConfigurationBuilder newConfigurationBuilder(URL... jars)

Description copied from interface: Tang

Create a new ConfigurationBuilder that is backed by the default classloader and the provided jars. Following standard Java's semantics, when looking up a class, Tang will consult the default classloader first, then the first classpath entry / jar passed to this method, then the second, and so on.

Specified by:

newConfigurationBuilder in interface Tang

Parameters:

jars - the locations of jar files

Returns:

a new JavaConfigurationBuilder

newConfigurationBuilder

public JavaConfigurationBuilder newConfigurationBuilder(Configuration... confs)
                                                 throws BindException

Description copied from interface: Tang

Merge a set of configurations into a new JavaConfiurationBuilder. If the configurations conflict, this method will throw a bind exception.

The underlying ClassHierarchies and parameter parsers of the configurations will be checked for consistency. The returned configuration builder will be backed by a ClassHierachy that incorporates the classpath and parsers from all of the provided Configurations.

Specified by:

newConfigurationBuilder in interface Tang

Parameters:

confs - configurations

Returns:

a new ConfigurationBuilder

Throws:

BindException - if any of the configurations contain duplicated or conflicting bindings, or if the backing ClassHierarchy objects conflict in some way.

newConfigurationBuilder

public final JavaConfigurationBuilder newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parsers)
                                                       throws BindException

Description copied from interface: Tang

Create an empty JavaConfigurationBuilder that is capable of parsing application-specific configuration values. The returned JavaConfigurationBuilder will be backed by the default classloader.

Specified by:

newConfigurationBuilder in interface Tang

Parameters:

parsers - the parsers for parameters

Returns:

a new ConfigurationBuilder

Throws:

BindException - if any of the configurations contain duplicated or conflicting bindings, or if the backing ClassHierarchy objects conflict in some way.

newConfigurationBuilder

public JavaConfigurationBuilder newConfigurationBuilder(URL[] jars,
                                               Configuration[] confs,
                                               Class<? extends ExternalConstructor<?>>[] parameterParsers)
                                                 throws BindException

Description copied from interface: Tang

Create a new JavaConfiguration builder that has additional jars, incorporates existing configuration data and / or can parse application-specific types. See the documentation for the other newConfigurationBuilder methods in this class for detailed information about each of the parameters to this method.

Specified by:

newConfigurationBuilder in interface Tang

Parameters:

jars - the locations of jar files

confs - configurations

parameterParsers - the parsers for parameters

Returns:

a configuration builder

Throws:

BindException

getDefaultClassHierarchy

public JavaClassHierarchy getDefaultClassHierarchy()

Specified by:

getDefaultClassHierarchy in interface Tang

Returns:

an instance of JavaClassHierarchy that is backed by the default Java classloader. ClassHierarchy objects are immutable, so multiple invocations of this method may return the same instance.

getDefaultClassHierarchy

public JavaClassHierarchy getDefaultClassHierarchy(URL[] jars,
                                          Class<? extends ExternalConstructor<?>>[] parameterParsers)

Description copied from interface: Tang

Get a default class hierarchy.

Specified by:

getDefaultClassHierarchy in interface Tang

Parameters:

jars - the locations of jar files

parameterParsers - the parsers

Returns:

a custom instance of JavaClassHierarchy. ClassHierarchy objects are immutable, so multiple invocations of this method may return the same instance. TODO Is the class hierarchy returned here backed by the default classloader or not? If not, then callers will need to merge it with getDefaultClassHierarchy(). If so, we should add a new method like getNonDefaultClassHiearchy() that takes the same options as this one.

newInjector

public Injector newInjector(Configuration confs)

Description copied from interface: Tang

Returns an Injector for the given Configuration.

Specified by:

newInjector in interface Tang

Parameters:

confs - a configuration

Returns:

an injector

newInjector

public Injector newInjector()

Description copied from interface: Tang

Returns an Injector based on an empty Configuration.

Specified by:

newInjector in interface Tang

Returns:

an injector