org.apache.reef.tang

Interface Tang

All Known Implementing Classes:

TangImpl

public interface Tang

The root factory interface for Tang. This interface allows callers to instantiate Tang's core API, and is responsible for memoization and other runtime optimizations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Tang.Factory A factory that returns the default implementation of the Tang interface.

Method Summary

Methods

Modifier and Type	Method and Description
JavaClassHierarchy	getDefaultClassHierarchy()
JavaClassHierarchy	getDefaultClassHierarchy(URL[] jars, Class<? extends ExternalConstructor<?>>[] parsers) Get a default class hierarchy.
JavaConfigurationBuilder	newConfigurationBuilder() Create a new empty ConfigurationBuilder that is backed by the default classloader.
JavaConfigurationBuilder	newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parameterParsers) 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.

Method Detail

newInjector

Injector newInjector(Configuration... confs)
                     throws BindException

Returns an Injector for the given Configurations.

Parameters:

confs - a configuration

Returns:

an injector

Throws:

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

newInjector

Injector newInjector(Configuration confs)

Returns an Injector for the given Configuration.

Parameters:

confs - a configuration

Returns:

an injector

newInjector

Injector newInjector()

Returns an Injector based on an empty Configuration.

Returns:

an injector

newConfigurationBuilder

ConfigurationBuilder newConfigurationBuilder(ClassHierarchy ch)

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

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

JavaConfigurationBuilder newConfigurationBuilder(URL... jars)

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.

Parameters:

jars - the locations of jar files

Returns:

a new JavaConfigurationBuilder

newConfigurationBuilder

JavaConfigurationBuilder newConfigurationBuilder(Configuration... confs)
                                                 throws BindException

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.

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

JavaConfigurationBuilder newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parameterParsers)
                                                 throws BindException

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

Parameters:

parameterParsers - 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

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

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.

Parameters:

jars - the locations of jar files

confs - configurations

parameterParsers - the parsers for parameters

Returns:

a configuration builder

Throws:

BindException

newConfigurationBuilder

JavaConfigurationBuilder newConfigurationBuilder()

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

Returns:

a configuration builder

getDefaultClassHierarchy

JavaClassHierarchy getDefaultClassHierarchy()

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

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

Get a default class hierarchy.

Parameters:

jars - the locations of jar files

parsers - 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.