org.apache.reef.wake.profiler

Class WakeProfiler

java.lang.Object

org.apache.reef.wake.profiler.WakeProfiler

All Implemented Interfaces:

Aspect

public class WakeProfiler
extends Object
implements Aspect

A graphical profiler class that instruments Tang-based Wake applications.

Constructor Summary

Constructors

Constructor and Description
WakeProfiler()

Method Summary

Methods

Modifier and Type	Method and Description
Aspect	createChildAspect() This method creates a child aspect, and returns it.
<T> T	inject(ConstructorDef<T> constructorDef, Constructor<T> constructor, Object[] args) Inject an object of type T.
<T> void	injectionFutureInstantiated(InjectionFuture<T> arg0, T arg1) TANG calls this the first time get() is called on an injection future.
String	objectGraphToString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WakeProfiler

public WakeProfiler()

Method Detail

createChildAspect

public Aspect createChildAspect()

Description copied from interface: Aspect

This method creates a child aspect, and returns it. This allows aspects to track information about Tang injection scopes. If such information is not needed, it is legal for Aspect implementations to return "this".

Specified by:

createChildAspect in interface Aspect

inject

public <T> T inject(ConstructorDef<T> constructorDef,
           Constructor<T> constructor,
           Object[] args)
         throws InvocationTargetException,
                IllegalAccessException,
                IllegalArgumentException,
                InstantiationException

Description copied from interface: Aspect

Inject an object of type T.

Note that it is never OK to return an instance of ExternalConstructor. Typical implementations check to see if they are about to return an instance of ExternalConstructor. If so, they return ret.newInstance() instead. It throws a number of exceptions which are passed-through from the wrapped call to newInstance().

Specified by:

inject in interface Aspect

Parameters:

constructorDef - information about the constructor to be invoked. This is mostly useful because it contains references to any relevant named parameters, and to the class to be injected.

constructor - The java constructor to be injected. Tang automatically chooses the appropriate constructor and ensures that we have permission to invoke it.

args - The parameters to be passed into constructor.newInstance(), in the correct order.

Returns:

A new instance of T. Note, it is inject()'s responsibility to call ret.getInstance() if ret instanceof ExternalConstructor.

Throws:

InvocationTargetException

IllegalAccessException

IllegalArgumentException

InstantiationException

injectionFutureInstantiated

public <T> void injectionFutureInstantiated(InjectionFuture<T> arg0,
                                   T arg1)

Description copied from interface: Aspect

TANG calls this the first time get() is called on an injection future. This informs the aspect of the relationship between InjectionFutures (that were already passed into inject()) and the instantiated object.

Specified by:

injectionFutureInstantiated in interface Aspect

Parameters:

arg0 - An InjectionFuture that was passed to the args[] array of inject at some point in the past.

arg1 - An object instance that was returned by inject().

objectGraphToString

public String objectGraphToString()