Package com.xceptance.xlt.api.engine

Class CustomValue

java.lang.Object

com.xceptance.xlt.api.engine.AbstractData

com.xceptance.xlt.api.engine.CustomValue

All Implemented Interfaces:

Data

public class CustomValue
extends AbstractData

The CustomValue can store a single 'double' value.

Field Summary

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

DELIMITER

Constructor Summary

Constructors

Constructor	Description
CustomValue()	Creates a new CustomValue object.
CustomValue(java.lang.String name)	Creates a new CustomValue object and gives it the specified name.

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.
protected int	getMinNoCSVElements()	Returns the minimum number of elements in the CSV string.
double	getValue()	Returns the value.
protected void	parseRemainingValues(java.util.List<XltCharBuffer> values)	Recreates the state of this object from an array of values.
void	setValue(double value)	Sets the value.

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

CustomValue

public CustomValue(java.lang.String name)

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

Parameters:

name - the statistics name

CustomValue

public CustomValue()

Creates a new CustomValue object.

Method Detail

setValue

public void setValue(double value)

Sets the value.

Parameters:

value - the value

getValue

public double getValue()

Returns the value.

Returns:

the value

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

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

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()