| com.uwyn.rife.continuations.ContinuationConfigInstrument
All known Subclasses: com.uwyn.rife.engine.EngineContinuationConfigInstrument, com.uwyn.rife.continuations.ContinuationConfigInstrumentTests,
| ContinuationConfigInstrument | | public interface ContinuationConfigInstrument (Code) | | This interface needs to be implemented to configure the bytecode
instrumentation that enables the continuations functionalities.
author:
Geert Bevin (gbevin[remove] at uwyn dot com)
version:
$Revision: 3811 $
since:
1.6 |
| Method Summary | |
| public String | getAnswerMethodName()
The name of the method that will trigger the answer to a call
continuation, for instance
"answer" . | | public Class[] | getCallMethodArgumentTypes()
| | public String | getCallMethodName()
The name of the method that will trigger a call continuation, for
instance
"call" . | | public Class | getCallMethodReturnType()
The return type of the call method, for instance
Object.class .
This needs to be an object, not a primitive and you have to be
certain that it's compatible with the values that are sent through the
answer to the call continuation. | | public String | getContinuableMarkerInterfaceName()
The name of the interface that will indicate that a class should be
instrumented for continuations functionalities, for instance
ContinuableObject.class.getName() . | | public String | getContinuableSupportClassName()
The class name of the support class that contains dummy implementations
of the continuation methods that are configured below, for instance
ContinuableSupport.class.getName() .
If you implement these methods in your continuable classes or extend
these classes from a common base class with those methods that are then
called locally, this configuration can return
null since it
will not be used. | | public Class[] | getEntryMethodArgumentTypes()
The array argument types that the entry method takes, for instance
null if it takes none. | | public String | getEntryMethodName()
The name of the entry method that will be invoked when a new instance
of a continuable class is created and its execution is started, for
instance
"execute" . | | public Class | getEntryMethodReturnType()
The return type of the entry method, for instance
void.class . | | public String | getPauseMethodName()
The name of the method that will trigger a pause continuation, for
instance
"pause" . | | public String | getStepbackMethodName()
The name of the method that will trigger a step-back continuation, for
instance
"stepback" . |
| getAnswerMethodName | | public String getAnswerMethodName()(Code) | | The name of the method that will trigger the answer to a call
continuation, for instance
"answer" .
This method should have a
void return type and take one
argument with the type
java.lang.Object .
the name of the answer method
since:
1.6 |
| getCallMethodArgumentTypes | | public Class[] getCallMethodArgumentTypes()(Code) | | |
| getCallMethodName | | public String getCallMethodName()(Code) | | The name of the method that will trigger a call continuation, for
instance
"call" .
the name of the call method
since:
1.6 |
| getCallMethodReturnType | | public Class getCallMethodReturnType()(Code) | | The return type of the call method, for instance
Object.class .
This needs to be an object, not a primitive and you have to be
certain that it's compatible with the values that are sent through the
answer to the call continuation. It's just recommended to keep this as
generic as possible (hence
Object.class ).
the type of the call method's return value
since:
1.6 |
| getContinuableMarkerInterfaceName | | public String getContinuableMarkerInterfaceName()(Code) | | The name of the interface that will indicate that a class should be
instrumented for continuations functionalities, for instance
ContinuableObject.class.getName() .
the name of the marker interface
since:
1.6 |
| getContinuableSupportClassName | | public String getContinuableSupportClassName()(Code) | | The class name of the support class that contains dummy implementations
of the continuation methods that are configured below, for instance
ContinuableSupport.class.getName() .
If you implement these methods in your continuable classes or extend
these classes from a common base class with those methods that are then
called locally, this configuration can return
null since it
will not be used. A class name only needs to be provided if your
continuable classes only implement the marker interface, and you call
the continuation methods on an instance of this support inside your
continuations logic.
the name of the continuable support class; or null if such a support class isn't used
since:
1.6 |
| getEntryMethodArgumentTypes | | public Class[] getEntryMethodArgumentTypes()(Code) | | The array argument types that the entry method takes, for instance
null if it takes none.
This will solely be used to detect and lookup the method before
instrumenting or calling it.
the array of argument types of the entry method; or null if there are none
since:
1.6 |
| getEntryMethodName | | public String getEntryMethodName()(Code) | | The name of the entry method that will be invoked when a new instance
of a continuable class is created and its execution is started, for
instance
"execute" .
the name of the entry method
since:
1.6 |
| getEntryMethodReturnType | | public Class getEntryMethodReturnType()(Code) | | The return type of the entry method, for instance
void.class .
This will solely be used to detect and lookup the method before
instrumenting or calling it.
the class of the entry method's return value
since:
1.6 |
| getPauseMethodName | | public String getPauseMethodName()(Code) | | The name of the method that will trigger a pause continuation, for
instance
"pause" .
This method should have a
void return type and take no
arguments.
the name of the pause method
since:
1.6 |
| getStepbackMethodName | | public String getStepbackMethodName()(Code) | | The name of the method that will trigger a step-back continuation, for
instance
"stepback" .
This method should have a
void return type and take no
arguments.
the name of the step-back method
since:
1.6 |
|
|