Package com.xceptance.xlt.api.engine

Class TimerData

java.lang.Object

com.xceptance.xlt.api.engine.AbstractData

com.xceptance.xlt.api.engine.TimerData

All Implemented Interfaces:

Data

Direct Known Subclasses:

ActionData, CustomData, PageLoadTimingData, RequestData, TransactionData

public abstract class TimerData
extends AbstractData

The TimerData class is the super class for all timer-based data records.

Field Summary

Fields inherited from interface com.xceptance.xlt.api.engine.Data

DELIMITER

Constructor Summary

Constructors

Constructor	Description
TimerData(char typeCode)	Creates a new TimerData object and gives it the specified type code.
TimerData(java.lang.String name, char typeCode)	Creates a new TimerData object and gives it the specified name and type code.

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	addValues()	Builds a list of string values that represents the state of this object.
long	getEndTime()	Returns the end time.
protected int	getMinNoCSVElements()	Returns the minimum number of elements in the CSV string.
int	getRunTime()	Returns the run time.
boolean	hasFailed()	Indicates whether or not a failure had occurred.
protected void	parseRemainingValues(java.util.List<XltCharBuffer> values)	Recreates the state of this object from an array of values.
void	setFailed(boolean failed)	Sets whether or not a failure had occurred.
void	setRunTime(int runTime)	Sets the run time.
void	setRunTime(long runTime)	Sets the run time.

Methods inherited from class com.xceptance.xlt.api.engine.AbstractData

baseValuesFromCSV, getAgentName, getName, getTime, getTransactionName, getTypeCode, parseBaseValues, parseValues, remainingValuesFromCSV, setAgentName, setName, setTime, setTransactionName, toCSV

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerData

public TimerData(char typeCode)

Creates a new TimerData object and gives it the specified type code.

Parameters:

typeCode - the type code

TimerData

public TimerData(java.lang.String name,
                 char typeCode)

Creates a new TimerData object and gives it the specified name and type code. Furthermore, the start time attribute is set to the current time.

Parameters:

name - the request name

typeCode - the type code

Method Detail

getEndTime

public long getEndTime()

Returns the end time. Calculated from start time and run time.

Returns:

the end time

getRunTime

public int getRunTime()

Returns the run time.

Returns:

the run time

hasFailed

public boolean hasFailed()

Indicates whether or not a failure had occurred.

Returns:

the failure status

setFailed

public void setFailed(boolean failed)

Sets whether or not a failure had occurred.

Parameters:

failed - the new status

setRunTime

public void setRunTime(long runTime)

Sets the run time. Convenience method for long values, but note that internally the value is cast to int.

Parameters:

runTime - the runTime

setRunTime

public void setRunTime(int runTime)

Sets the run time.

Parameters:

runTime - the runTime

addValues

protected java.util.List<java.lang.String> addValues()

Builds a list of string values that represents the state of this object. Override this method in sub classes to add custom values and use the list created by the super class.

Overrides:

addValues in class AbstractData

Returns:

the list of values

parseRemainingValues

protected void parseRemainingValues(java.util.List<XltCharBuffer> values)

Recreates the state of this object from an array of values. Override this method in sub classes to restore custom values.

Specified by:

parseRemainingValues in class AbstractData

Parameters:

values - the list of values, must have at least the length AbstractData.getMinNoCSVElements()

getMinNoCSVElements

protected int getMinNoCSVElements()

Returns the minimum number of elements in the CSV string.

Overrides:

getMinNoCSVElements in class AbstractData

Returns:

minimum number of elements in the CSV string