riffle.process.scheduler

Class ProcessWrapper

java.lang.Object

riffle.process.scheduler.ProcessWrapper

All Implemented Interfaces:

Serializable

public class ProcessWrapper
extends Object
implements Serializable

Class ProcessWrapper wraps an Object instance that has the Process class Annotation and all relevant method Annotations.

It is generally unnecessary for users to use this class directly. ProcessChain will automatically wrap process objects with an instance of this class.

See Also:

ProcessChain, Process, ProcessPrepare, ProcessStart, ProcessStop, ProcessComplete, ProcessCleanup, DependencyOutgoing, DependencyIncoming, ProcessCounters, ProcessChildren, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessWrapper(Object process)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Method cleanup calls the annotated child Process object ProcessCleanup method.
void	complete()
List<Object>	getChildren()
Object	getConfiguration()
Map<String,Map<String,Long>>	getCounters()
Object	getDependencyIncoming()
Object	getDependencyOutgoing()
boolean	hasChildren()
boolean	hasCleanup() Method hasCleanup returns true if the annotated child Process object implements the ProcessCleanup method.
boolean	hasCounters()
boolean	hasPrepare() Method hasPrepare returns true if the annotated child Process object implements the ProcessPrepare method.
boolean	hasStart() Method hasStart returns true if the annotated child Process object implements the ProcessStart method.
void	prepare() Method prepare calls the annotated child Process object ProcessPrepare method.
void	start() Method start calls the annotated child Process object ProcessStart method.
void	stop()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessWrapper

public ProcessWrapper(Object process)

Method Detail

getDependencyOutgoing

public Object getDependencyOutgoing()
                             throws ProcessException

Throws:

ProcessException

getDependencyIncoming

public Object getDependencyIncoming()
                             throws ProcessException

Throws:

ProcessException

getConfiguration

public Object getConfiguration()
                        throws ProcessException

Throws:

ProcessException

hasPrepare

public boolean hasPrepare()

Method hasPrepare returns true if the annotated child Process object implements the ProcessPrepare method.

Returns:

boolean

prepare

public void prepare()
             throws ProcessException

Method prepare calls the annotated child Process object ProcessPrepare method.

This method will not fail if the prepare method is not implemented.

Throws:

ProcessException - when

hasCleanup

public boolean hasCleanup()

Method hasCleanup returns true if the annotated child Process object implements the ProcessCleanup method.

Returns:

boolean

cleanup

public void cleanup()
             throws ProcessException

Method cleanup calls the annotated child Process object ProcessCleanup method.

This method will not fail if the cleanup method is not implemented.

Throws:

ProcessException - when

hasStart

public boolean hasStart()

Method hasStart returns true if the annotated child Process object implements the ProcessStart method.

Returns:

boolean

start

public void start()
           throws ProcessException

Method start calls the annotated child Process object ProcessStart method.

This method will throw an exception if the start method is not implemented. Call hasStart() to verify before calling.

Throws:

ProcessException - when there is a failure

complete

public void complete()
              throws ProcessException

Throws:

ProcessException

stop

public void stop()
          throws ProcessException

Throws:

ProcessException

hasCounters

public boolean hasCounters()
                    throws ProcessException

Throws:

ProcessException

getCounters

public Map<String,Map<String,Long>> getCounters()
                                         throws ProcessException

Throws:

ProcessException

hasChildren

public boolean hasChildren()
                    throws ProcessException

Throws:

ProcessException

getChildren

public List<Object> getChildren()
                         throws ProcessException

Throws:

ProcessException

toString

public String toString()

Overrides:

toString in class Object