org.safs.model

Class AbstractTestRecord

java.lang.Object

org.safs.model.AbstractTestRecord

All Implemented Interfaces:

TestRecordParametersInterface

Direct Known Subclasses:

AbstractCommand, AbstractTestTable

public abstract class AbstractTestRecord
extends java.lang.Object
implements TestRecordParametersInterface

The first concrete (though still abstract) implementation of the TestRecordParametersInterface. Provides the base functionality for storing command parameters and properly exporting them when tasked to append them to a test record. This mechanism is the same for both individual commands and multi-record test tables.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	_parameters
static java.lang.String	BLOCKID_RECORD_TYPE 'B'
static java.lang.String	BREAKPOINT_RECORD_TYPE 'BP'
static java.lang.String	COMPONENT_FUNCTION_FAILOK_RECORD_TYPE 'TF'
static java.lang.String	COMPONENT_FUNCTION_RECORD_TYPE 'T'
static java.lang.String	COMPONENT_FUNCTION_WARNOK_RECORD_TYPE 'TW'
static java.lang.String	DRIVER_COMMAND_FAILOK_RECORD_TYPE 'CF'
static java.lang.String	DRIVER_COMMAND_RECORD_TYPE 'C'
static java.lang.String	DRIVER_COMMAND_WARNOK_RECORD_TYPE 'CW'
static java.lang.String	EMPTY_PARAMETER Identifies an empty value that can be specified for optional parameters.
static java.lang.String	ENGINE_COMMAND_FAILOK_RECORD_TYPE 'EF'
static java.lang.String	ENGINE_COMMAND_RECORD_TYPE 'E'
static java.lang.String	ENGINE_COMMAND_WARNOK_RECORD_TYPE 'EW'
static java.lang.String	PROJECT_COMMAND_RECORD_TYPE 'T'
static java.lang.String	SKIPPED_RECORD_TYPE 'S'

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTestRecord() Initializes our parameters list with an empty List.

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String parameter) Add a parameter to the current list of parameters associated with the record.
void	addParameters(java.lang.String[] parameters) Add an array of parameters to the current list of parameters associated with the record.
java.lang.StringBuffer	appendParametersToTestRecord(java.lang.StringBuffer buffer, java.lang.String fieldSeparator) Appends all record or table invocation parameters to the provided buffer.
java.util.List	getParameters() Retrieve the unmodifiableList of parameters associated with the record.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.model.TestRecordParametersInterface

exportTestRecord

Field Detail

EMPTY_PARAMETER

public static final java.lang.String EMPTY_PARAMETER

Identifies an empty value that can be specified for optional parameters.

See Also:

Constant Field Values

BLOCKID_RECORD_TYPE

public static final java.lang.String BLOCKID_RECORD_TYPE

'B'

See Also:

Constant Field Values

BREAKPOINT_RECORD_TYPE

public static final java.lang.String BREAKPOINT_RECORD_TYPE

'BP'

See Also:

Constant Field Values

COMPONENT_FUNCTION_RECORD_TYPE

public static final java.lang.String COMPONENT_FUNCTION_RECORD_TYPE

'T'

See Also:

Constant Field Values

COMPONENT_FUNCTION_WARNOK_RECORD_TYPE

public static final java.lang.String COMPONENT_FUNCTION_WARNOK_RECORD_TYPE

'TW'

See Also:

Constant Field Values

COMPONENT_FUNCTION_FAILOK_RECORD_TYPE

public static final java.lang.String COMPONENT_FUNCTION_FAILOK_RECORD_TYPE

'TF'

See Also:

Constant Field Values

DRIVER_COMMAND_RECORD_TYPE

public static final java.lang.String DRIVER_COMMAND_RECORD_TYPE

'C'

See Also:

Constant Field Values

DRIVER_COMMAND_WARNOK_RECORD_TYPE

public static final java.lang.String DRIVER_COMMAND_WARNOK_RECORD_TYPE

'CW'

See Also:

Constant Field Values

DRIVER_COMMAND_FAILOK_RECORD_TYPE

public static final java.lang.String DRIVER_COMMAND_FAILOK_RECORD_TYPE

'CF'

See Also:

Constant Field Values

ENGINE_COMMAND_RECORD_TYPE

public static final java.lang.String ENGINE_COMMAND_RECORD_TYPE

'E'

See Also:

Constant Field Values

ENGINE_COMMAND_WARNOK_RECORD_TYPE

public static final java.lang.String ENGINE_COMMAND_WARNOK_RECORD_TYPE

'EW'

See Also:

Constant Field Values

ENGINE_COMMAND_FAILOK_RECORD_TYPE

public static final java.lang.String ENGINE_COMMAND_FAILOK_RECORD_TYPE

'EF'

See Also:

Constant Field Values

PROJECT_COMMAND_RECORD_TYPE

public static final java.lang.String PROJECT_COMMAND_RECORD_TYPE

'T'

See Also:

Constant Field Values

SKIPPED_RECORD_TYPE

public static final java.lang.String SKIPPED_RECORD_TYPE

'S'

See Also:

Constant Field Values

_parameters

protected java.util.List _parameters

Constructor Detail

AbstractTestRecord

protected AbstractTestRecord()

Initializes our parameters list with an empty List. Invoked from subclasses via the super() mechanism.

Method Detail

getParameters

public java.util.List getParameters()

Retrieve the unmodifiableList of parameters associated with the record.

Specified by:

getParameters in interface TestRecordParametersInterface

Returns:

unmodifiableList of parameters

addParameter

public void addParameter(java.lang.String parameter)

Add a parameter to the current list of parameters associated with the record. Null parameters are converted to zero-length EMPTY_PARAMETERS.

Specified by:

addParameter in interface TestRecordParametersInterface

Parameters:

parameter - -- null parameters are converted to EMPTY_PARAMETERs

addParameters

public void addParameters(java.lang.String[] parameters)

Add an array of parameters to the current list of parameters associated with the record. If the specified array is null then no action is taken. Calls addParameter for each individual element in the array.

Specified by:

addParameters in interface TestRecordParametersInterface

Parameters:

String[] - parameters -- if null then no action is taken

appendParametersToTestRecord

public java.lang.StringBuffer appendParametersToTestRecord(java.lang.StringBuffer buffer,
                                                           java.lang.String fieldSeparator)

Appends all record or table invocation parameters to the provided buffer. This is normally called as part of the export mechanism and most users will not normally ever call this directly.

Specified by:

appendParametersToTestRecord in interface TestRecordParametersInterface

Parameters:

buffer - -- the test record export string being built by the export mechanism

fieldSeparator - -- the delimiter used between test record fields

Returns:

the buffer with our parameters added onto it