RobotJHook (SAFS API DOCUMENT)

java.lang.Object
- org.safs.RobotJHook

Direct Known Subclasses:

RRobotJHook
```
public abstract class RobotJHook
extends java.lang.Object
```
Description : RobotJ Hook Script *** This class needs to be eliminated with RRobotJHook subclassing 'JavaHook' ***

Since:

JUN 12, 2003
JUN 12, 2003 (DBauman) Original Release
JUN 25, 2003 dbauman: modified to be part of org.safs and use STAFHelper.java
SEP 16, 2003 Carl Nagle : modified to use new LogUtilities instance for logging
DEC 08, 2004 (Carl Nagle) Added support for evaluateRuntimeExceptions
FEB 27, 2009 (Carl Nagle) Moving START into RRobotJHook

Author:

Carl Nagle

See Also:

JavaHook, RRobotJHook

Field Summary

Fields
Modifier and Type	Field and Description
`protected TestRecordHelper`	`data`
`protected static int`	`DEBUG_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected static int`	`FAILED_MESSAGE` Log MessageType for local referencing.
`protected static int`	`FAILED_OK_MESSAGE` Log MessageType for local referencing.
`protected static int`	`GENERIC_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected static STAFHelper`	`helper`
`protected LogUtilities`	`log`
`protected static int`	`PASSED_MESSAGE` Log MessageType for local referencing.
`protected ProcessRequest`	`processor`
`static long`	`REQUEST_PROCEED_TESTING` 0 Proceed with normal testing
`static long`	`REQUEST_USER_STOPPED_SCRIPT_REQUEST` -1 The user has requested to STOP or ABORT execution of this engine.
`static java.lang.String`	`ROBOTJ_PROCESS_NAME`
`static java.lang.String`	`SHUTDOWN_RECORD`
`protected DDGUIUtilities`	`utils`
`protected static int`	`WARNING_MESSAGE` Log MessageType for local referencing.
`protected static int`	`WARNING_OK_MESSAGE` Log MessageType for local referencing.

Constructor Summary

Constructors
Constructor and Description

RobotJHook()

Constructors
Constructor and Description
`RobotJHook()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`STAFHelper`	`getHelper()`
`protected abstract TestRecordHelper`	`getTestRecordDataFactory()`
`protected abstract TestRecordHelper`	`getTestRecordDataFactory(DDGUIUtilities utils)`
`protected abstract DDGUIUtilities`	`getUtilitiesFactory()`
`protected void`	`initializeUtilities()` Allows subclasses to change some portions of the initialization that occurs inside the start() method.
`void`	`setLogUtil(LogUtilities lu)` Allows the running script to set the appropriate LogUtilities class/subclass to manage logging

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SHUTDOWN_RECORD
```
public static final java.lang.String SHUTDOWN_RECORD
```
    See Also:
    
    Constant Field Values
  - ROBOTJ_PROCESS_NAME
```
public static final java.lang.String ROBOTJ_PROCESS_NAME
```
    See Also:
    
    Constant Field Values
  - helper
```
protected static STAFHelper helper
```
  - log
```
protected LogUtilities log
```
  - DEBUG_MESSAGE
```
protected static final int DEBUG_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - GENERIC_MESSAGE
```
protected static final int GENERIC_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - FAILED_MESSAGE
```
protected static final int FAILED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - FAILED_OK_MESSAGE
```
protected static final int FAILED_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - PASSED_MESSAGE
```
protected static final int PASSED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_MESSAGE
```
protected static final int WARNING_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_OK_MESSAGE
```
protected static final int WARNING_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - REQUEST_USER_STOPPED_SCRIPT_REQUEST
```
public static final long REQUEST_USER_STOPPED_SCRIPT_REQUEST
```
    -1 The user has requested to STOP or ABORT execution of this engine. This is often done by a special HOTKEY or some other tool-specific means.
    
    See Also:
    
    Constant Field Values
  - REQUEST_PROCEED_TESTING
```
public static final long REQUEST_PROCEED_TESTING
```
    0 Proceed with normal testing
    
    See Also:
    
    Constant Field Values
  - utils
```
protected DDGUIUtilities utils
```
  - data
```
protected TestRecordHelper data
```
  - processor
```
protected ProcessRequest processor
```
- Constructor Detail
  - RobotJHook
```
public RobotJHook()
```
- Method Detail
  - getHelper
```
public STAFHelper getHelper()
```
  - setLogUtil
```
public void setLogUtil(LogUtilities lu)
```
    Allows the running script to set the appropriate LogUtilities class/subclass to manage logging
    
    Parameters:
    
    lu - LogUtilities used for logging
  - initializeUtilities
```
protected void initializeUtilities()
```
    Allows subclasses to change some portions of the initialization that occurs inside the start() method. Initializes DDGUIUitlities, TestRecordHelper, ProcessRequest objects.
    
    See Also:
    
    getUtilitiesFactory(), #getTestRecordDataFactory(DDGUIUtilities, ProcessRequest#ProcessRequest(TestRecordHelper, LogUtilities))
  - getUtilitiesFactory
```
protected abstract DDGUIUtilities getUtilitiesFactory()
```
  - getTestRecordDataFactory
```
protected abstract TestRecordHelper getTestRecordDataFactory()
```
  - getTestRecordDataFactory
```
protected abstract TestRecordHelper getTestRecordDataFactory(DDGUIUtilities utils)
```

Class RobotJHook

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHUTDOWN_RECORD

ROBOTJ_PROCESS_NAME

helper

log

DEBUG_MESSAGE

GENERIC_MESSAGE

FAILED_MESSAGE

FAILED_OK_MESSAGE

PASSED_MESSAGE

WARNING_MESSAGE

WARNING_OK_MESSAGE

REQUEST_USER_STOPPED_SCRIPT_REQUEST

REQUEST_PROCEED_TESTING

utils

data

processor

Constructor Detail

RobotJHook

Method Detail

getHelper

setLogUtil

initializeUtilities

getUtilitiesFactory

getTestRecordDataFactory

getTestRecordDataFactory