| Package | Description | 
|---|---|
| org.apache.reef.client | 
 Client APIs for REEF. 
 | 
| org.apache.reef.examples.data.loading | |
| org.apache.reef.examples.hello | 
 The Hello REEF example. 
 | 
| org.apache.reef.examples.helloCLR | 
 The Hello REEF example for the CLR. 
 | 
| org.apache.reef.examples.hellohttp | |
| org.apache.reef.io.data.loading.api | |
| org.apache.reef.tang | 
 Public interfaces and factories for Tang's core API. 
 | 
| org.apache.reef.tang.examples | 
 Example code from the tutorial on Tang's home page. 
 | 
| org.apache.reef.tang.examples.timer | 
 A more complicated version of the Timer example, including delegating
  interfaces to default implementations. 
 | 
| org.apache.reef.tang.exceptions | 
 Exceptions thrown by Tang, including runtime exceptions that reflect
 compile-time inconsistencies and other problems that can't be
 meaningfully handled by application code. 
 | 
| org.apache.reef.tang.formats | 
 Tang format classes encode and decode information that Tang gathers at
 runtime. 
 | 
| org.apache.reef.tang.implementation | 
 Tang's implementation. 
 | 
| org.apache.reef.tang.implementation.java | 
 Private implementation classes that configure and inject code written
 in Java. 
 | 
| org.apache.reef.tang.implementation.protobuf | 
 Implementation classes that translate between Tang's core API and protocol
 buffers. 
 | 
| org.apache.reef.tang.implementation.types | 
 Implementations of the ClassHierarchy type system. 
 | 
| org.apache.reef.tang.types | 
 The interfaces that define Tang's ClassHierarchy objects. 
 | 
| org.apache.reef.tang.util | 
 Miscellaneous utilities, including command line static analysis (Tint), data structures and reflection stuff. 
 | 
| org.apache.reef.tests | |
| org.apache.reef.tests.fail.driver | |
| org.apache.reef.tests.fail.task | |
| org.apache.reef.tests.messaging.driver | 
| Modifier and Type | Method and Description | 
|---|---|
static DriverLauncher | 
DriverLauncher.getLauncher(Configuration runtimeConfiguration)
Instantiate a launcher for the given Configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
DataLoadingREEF.main(String[] args)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
HelloREEFNoClient.main(String[] args)  | 
static void | 
HelloREEF.main(String[] args)
Start Hello REEF job. 
 | 
static LauncherStatus | 
HelloREEF.runHelloReef(Configuration runtimeConf,
                        int timeOut)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
HelloCLR.main(String[] args)
Start Hello REEF job. 
 | 
static LauncherStatus | 
HelloCLR.runHelloCLR(Configuration runtimeConf,
                      int timeOut,
                      File clrFolder)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
HelloREEFHttpYarn.main(String[] args)
Start Hello REEF job. 
 | 
static LauncherStatus | 
HelloREEFHttp.runHelloReef(Configuration runtimeConf,
                        int timeOut)
Run Hello Reef with merged configuration 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
DataLoadingRequestBuilder.build()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfigurationBuilder.addConfiguration(Configuration c)
Add all configuration parameters from the given Configuration object. 
 | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bind(Class<T> iface,
        Class<?> impl)
Bind named parameters, implementations or external constructors, depending
 on the types of the classes passed in. 
 | 
void | 
ConfigurationBuilder.bind(Node iface,
        Node impl)
Bind classes to each other, based on their full class names; alternatively,
 bound a NamedParameter configuration option to a configuration value. 
 | 
<T> void | 
ConfigurationBuilder.bind(String iface,
        String impl)
Bind classes to each other, based on their full class names; alternatively,
 bound a NamedParameter configuration option to a configuration value. 
 | 
<T> void | 
Injector.bindAspect(Aspect a)
Binds a TANG Aspect to this injector. 
 | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindConstructor(Class<T> c,
                              Class<? extends ExternalConstructor<? extends T>> v)  | 
<T> void | 
ConfigurationBuilder.bindConstructor(ClassNode<T> iface,
                              ClassNode<? extends ExternalConstructor<? extends T>> impl)
Register an ExternalConstructor implementation with Tang. 
 | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindImplementation(Class<T> iface,
                                    Class<? extends T> impl)
Binds the Class impl as the implementation of the interface iface 
 | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindList(Class<? extends Name<List<T>>> iface,
                List impl)
Binds a specfic list to a named parameter. 
 | 
<T> void | 
ConfigurationBuilder.bindList(NamedParameterNode<List<T>> iface,
                List implList)
Bind an list of implementations(Class or String) to an given NamedParameter. 
 | 
void | 
ConfigurationBuilder.bindList(String iface,
                List implList)  | 
JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindNamedParameter(Class<? extends Name<?>> name,
                                    String value)
Set the value of a named parameter. 
 | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindNamedParameter(Class<? extends Name<T>> iface,
                                    Class<? extends T> impl)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindSetEntry(Class<? extends Name<Set<T>>> iface,
                        Class<? extends T> impl)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilder.bindSetEntry(Class<? extends Name<Set<T>>> iface,
                        String value)  | 
<T> void | 
ConfigurationBuilder.bindSetEntry(NamedParameterNode<Set<T>> iface,
                        Node impl)  | 
<T> void | 
ConfigurationBuilder.bindSetEntry(NamedParameterNode<Set<T>> iface,
                        String impl)  | 
void | 
ConfigurationBuilder.bindSetEntry(String iface,
                        Node impl)  | 
void | 
ConfigurationBuilder.bindSetEntry(String iface,
                        String impl)  | 
<T> void | 
Injector.bindVolatileInstance(Class<T> iface,
                                        T inst)
Binds the given object to the class. 
 | 
<T> void | 
Injector.bindVolatileParameter(Class<? extends Name<T>> iface,
                                          T inst)  | 
String | 
ConfigurationBuilder.classPrettyDefaultString(String longName)
Pretty print the default implementation / value of the provided class / NamedParamter. 
 | 
String | 
ConfigurationBuilder.classPrettyDescriptionString(String longName)
Pretty print the human readable documentation of the provided class / NamedParamter. 
 | 
Injector | 
Injector.forkInjector(Configuration... configurations)
Create a copy of this Injector that inherits the instances that were already
 created by this Injector, but reflects additional Configuration objects. 
 | 
boolean | 
Injector.isInjectable(Class<?> clazz)  | 
boolean | 
Injector.isInjectable(String name)
Returns true if this Injector is able to instantiate the object named by
 name. 
 | 
boolean | 
Injector.isParameterSet(Class<? extends Name<?>> name)  | 
boolean | 
Injector.isParameterSet(String name)  | 
JavaConfigurationBuilder | 
Tang.newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parameterParsers)
Create an empty JavaConfigurationBuilder that is capable of parsing
 application-specific configuration values. 
 | 
JavaConfigurationBuilder | 
Tang.newConfigurationBuilder(Configuration... confs)
Merge a set of configurations into a new JavaConfiurationBuilder. 
 | 
JavaConfigurationBuilder | 
Tang.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 | 
Tang.newInjector(Configuration... confs)
Returns an Injector for the given Configurations. 
 | 
void | 
ConfigurationBuilder.registerLegacyConstructor(ClassNode<?> cn,
                                                  ClassNode<?>... args)
Force Tang to treat the specified constructor as though it had an @Inject
 annotation. 
 | 
void | 
ConfigurationBuilder.registerLegacyConstructor(ClassNode<?> c,
                                                  ConstructorArg... args)
Force Tang to treat the specified constructor as though it had an @Inject
 annotation. 
 | 
void | 
ConfigurationBuilder.registerLegacyConstructor(String cn,
                                                  String... args)
Force Tang to treat the specified constructor as though it had an @Inject
 annotation. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
TimerV1.main(String[] args)  | 
static void | 
PrintTypeHierarchy.main(String[] args)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
TimerMock.main(String[] args)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
NameResolutionException
Thrown when Tang encounters an unknown (to the current classloader) class
 or configuration option. 
 | 
class  | 
ParseException
Thrown when a string fails to parse as the requested type. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
ConfigurationFile.addConfiguration(ConfigurationBuilder conf,
                                File tmpConfFile)
Deprecated. 
 
in Tang 0.2 Use AvroConfigurationSerializer instead. 
 | 
static void | 
ConfigurationFile.addConfiguration(ConfigurationBuilder conf,
                                String contents)
Deprecated. 
 
in Tang 0.2 Use AvroConfigurationSerializer instead. 
 | 
void | 
ParameterParser.addParser(Class<? extends ExternalConstructor<?>> ec)  | 
<T,U extends T>  | 
ParameterParser.addParser(Class<U> clazz,
                  Class<? extends ExternalConstructor<T>> ec)  | 
Configuration | 
ConfigurationModule.build()  | 
Configuration | 
AvroConfigurationSerializer.fromAvro(AvroConfiguration avroConfiguration)
Converts a given AvroConfiguration to Configuration 
 | 
Configuration | 
AvroConfigurationSerializer.fromAvro(AvroConfiguration avroConfiguration,
                ClassHierarchy classHierarchy)
Converts a given AvroConfiguration to Configuration 
 | 
Configuration | 
ConfigurationSerializer.fromByteArray(byte[] theBytes)
Loads a Configuration from a byte[] created with toByteArray(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromByteArray(byte[] theBytes)  | 
Configuration | 
ConfigurationSerializer.fromByteArray(byte[] theBytes,
                          ClassHierarchy classHierarchy)
Loads a Configuration from a byte[] created with toByteArray(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromByteArray(byte[] theBytes,
                          ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromFile(File file)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromFile(File file)  | 
Configuration | 
ConfigurationSerializer.fromFile(File file,
                ClassHierarchy classHierarchy)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromFile(File file,
                ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromString(String theString)
Decodes a String generated via toString() 
 | 
Configuration | 
AvroConfigurationSerializer.fromString(String theString)  | 
Configuration | 
ConfigurationSerializer.fromString(String theString,
                    ClassHierarchy classHierarchy)
Decodes a String generated via toString() 
 | 
Configuration | 
AvroConfigurationSerializer.fromString(String theString,
                    ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromTextFile(File file)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromTextFile(File file)  | 
Configuration | 
AvroConfigurationSerializer.fromTextFile(File file,
                        ClassHierarchy classHierarchy)  | 
<T> CommandLine | 
CommandLine.processCommandLine(String[] args,
                                    Class<? extends Name<?>>... argClasses)  | 
CommandLine | 
CommandLine.registerShortNameOfClass(Class<? extends Name<?>> c)  | 
CommandLine | 
CommandLine.registerShortNameOfClass(String s)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfigurationBuilderImpl.addConfiguration(Configuration conf)  | 
void | 
ConfigurationBuilderImpl.bind(Node key,
        Node value)  | 
<T> void | 
ConfigurationBuilderImpl.bind(String key,
        String value)  | 
<T> void | 
ConfigurationBuilderImpl.bindImplementation(ClassNode<T> n,
                                    ClassNode<? extends T> m)  | 
<T> void | 
ConfigurationBuilderImpl.bindParameter(NamedParameterNode<T> name,
                          String value)  | 
<T> void | 
ConfigurationBuilderImpl.bindSetEntry(NamedParameterNode<Set<T>> iface,
                        Node impl)  | 
<T> void | 
ConfigurationBuilderImpl.bindSetEntry(NamedParameterNode<Set<T>> iface,
                        String impl)  | 
void | 
ConfigurationBuilderImpl.bindSetEntry(String iface,
                        Node impl)  | 
void | 
ConfigurationBuilderImpl.bindSetEntry(String iface,
                        String impl)  | 
JavaConfigurationBuilder | 
TangImpl.newConfigurationBuilder(Class<? extends ExternalConstructor<?>>... parsers)  | 
JavaConfigurationBuilder | 
TangImpl.newConfigurationBuilder(Configuration... confs)  | 
JavaConfigurationBuilder | 
TangImpl.newConfigurationBuilder(URL[] jars,
                                              Configuration[] confs,
                                              Class<? extends ExternalConstructor<?>>[] parameterParsers)  | 
Injector | 
TangImpl.newInjector(Configuration... confs)  | 
void | 
ConfigurationBuilderImpl.registerLegacyConstructor(ClassNode<?> cn,
                                                  ClassNode<?>... args)  | 
void | 
ConfigurationBuilderImpl.registerLegacyConstructor(ClassNode<?> c,
                                                  ConstructorArg... args)  | 
void | 
ConfigurationBuilderImpl.registerLegacyConstructor(String s,
                                                  String... args)  | 
| Modifier and Type | Method and Description | 
|---|---|
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bind(Class<T> c,
        Class<?> val)  | 
<T> void | 
InjectorImpl.bindAspect(Aspect a)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindConstructor(Class<T> c,
                              Class<? extends ExternalConstructor<? extends T>> v)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindImplementation(Class<T> c,
                                    Class<? extends T> d)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindList(Class<? extends Name<List<T>>> iface,
                List implList)
Binding list method for JavaConfigurationBuilder. 
 | 
JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindNamedParameter(Class<? extends Name<?>> name,
                                    String value)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindNamedParameter(Class<? extends Name<T>> iface,
                                    Class<? extends T> impl)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindSetEntry(Class<? extends Name<Set<T>>> iface,
                        Class<? extends T> impl)  | 
<T> JavaConfigurationBuilder | 
JavaConfigurationBuilderImpl.bindSetEntry(Class<? extends Name<Set<T>>> iface,
                        String value)  | 
<T> void | 
InjectorImpl.bindVolatileInstance(Class<T> c,
                                        T o)  | 
<T> void | 
InjectorImpl.bindVolatileParameter(Class<? extends Name<T>> c,
                                          T o)  | 
Injector | 
InjectorImpl.forkInjector(Configuration... configurations)  | 
boolean | 
InjectorImpl.isParameterSet(Class<? extends Name<?>> name)  | 
| Constructor and Description | 
|---|
InjectorImpl(Configuration c)  | 
JavaConfigurationBuilderImpl(Configuration[] confs)  | 
JavaConfigurationBuilderImpl(URL[] jars)  | 
JavaConfigurationBuilderImpl(URL[] jars,
                                                        Configuration[] confs,
                                                        Class<? extends ExternalConstructor<?>>[] parsers)  | 
| Modifier and Type | Method and Description | 
|---|---|
<T> InjectionPlan<T> | 
ProtocolBufferInjectionPlan.deserialize(ClassHierarchy ch,
                      InjectionPlanProto.InjectionPlan ip)  | 
| Modifier and Type | Method and Description | 
|---|---|
ConstructorDef<T> | 
ClassNodeImpl.getConstructorDef(ClassNode<?>... paramTypes)  | 
| Modifier and Type | Method and Description | 
|---|---|
ConstructorDef<T> | 
ClassNode.getConstructorDef(ClassNode<?>... args)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
ValidateConfiguration.main(String[] argv)  | 
void | 
ValidateConfiguration.validatePlan()  | 
| Modifier and Type | Method and Description | 
|---|---|
static TestDriverLauncher | 
TestDriverLauncher.getLauncher(Configuration runtimeConfiguration)
Instantiate a launcher for the given Configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
FailClient.run(Class<?> failMsgClass,
      Configuration runtimeConfig,
      int timeOut)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
Client.run(Class<? extends Task> failTaskClass,
      Configuration runtimeConfig,
      int timeOut)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
DriverMessaging.run(Configuration runtimeConfiguration,
      int launcherTimeout)  | 
Copyright © 2015 The Apache Software Foundation. All rights reserved.