TPTP 4.3.0 Testing Tools Project
Public API Specification

org.eclipse.tptp.test.provisional.recorder.framework
Class RecorderClientHelperAdapter

java.lang.Object
  extended byorg.eclipse.tptp.test.provisional.recorder.framework.RecorderClientHelperAdapter
All Implemented Interfaces:
IRecorderClientHelper, IRecorderProvider
Direct Known Subclasses:
DefaultRecorderClientHelper

public abstract class RecorderClientHelperAdapter
extends java.lang.Object
implements IRecorderClientHelper

Adapter for the RecorderClientHelper. Note that preSetup() MUST be implemented.

See Also:
IRecorderClientHelper

Constructor Summary
RecorderClientHelperAdapter()
           
 
Method Summary
 boolean cleanup()
          Called after testgen completes.
 Recorder getRecorder()
           
 java.lang.String getRecorderID()
           
 boolean okToLaunch()
          Called before any other calls, to verify that it is OK to proceed.
 boolean postStartRecording()
          Called after recording is started
 boolean postStopRecording()
          Called after recording stops & finishes.
abstract  boolean preSetup()
          Called before any other initialization steps.
 boolean preStartRecording()
          Called immediately before recording is started.
 boolean preStopRecording()
          Called immediately before recording is stopped.
 void setRecorder(Recorder recorder)
          Sets a Recorder object.
 void setRecorder(java.lang.String id)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RecorderClientHelperAdapter

public RecorderClientHelperAdapter()
Method Detail

okToLaunch

public boolean okToLaunch()
Description copied from interface: IRecorderClientHelper
Called before any other calls, to verify that it is OK to proceed.

Specified by:
okToLaunch in interface IRecorderClientHelper
Returns:
true if it is ok to begin recorder launch

preSetup

public abstract boolean preSetup()
Description copied from interface: IRecorderClientHelper
Called before any other initialization steps. If using RecorderClientHelperAdapter MUST extend this method

Specified by:
preSetup in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed

preStartRecording

public boolean preStartRecording()
Description copied from interface: IRecorderClientHelper
Called immediately before recording is started.

Specified by:
preStartRecording in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed

postStartRecording

public boolean postStartRecording()
Description copied from interface: IRecorderClientHelper
Called after recording is started

Specified by:
postStartRecording in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed

preStopRecording

public boolean preStopRecording()
Description copied from interface: IRecorderClientHelper
Called immediately before recording is stopped.

Specified by:
preStopRecording in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed

postStopRecording

public boolean postStopRecording()
Description copied from interface: IRecorderClientHelper
Called after recording stops & finishes.

Specified by:
postStopRecording in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed

cleanup

public boolean cleanup()
Description copied from interface: IRecorderClientHelper
Called after testgen completes. Use this method for final recorder cleanup.

Specified by:
cleanup in interface IRecorderClientHelper
Returns:
true if no errors and OK to proceed.

getRecorder

public Recorder getRecorder()
Specified by:
getRecorder in interface IRecorderProvider

getRecorderID

public java.lang.String getRecorderID()
Specified by:
getRecorderID in interface IRecorderProvider

setRecorder

public void setRecorder(java.lang.String id)
Specified by:
setRecorder in interface IRecorderProvider

setRecorder

public void setRecorder(Recorder recorder)
Description copied from interface: IRecorderProvider
Sets a Recorder object. Provided for compatibility with old recorder framework.

Specified by:
setRecorder in interface IRecorderProvider
Parameters:
recorder -

TPTP 4.3.0 Testing Tools Project
Public API Specification