MeasurementUnit (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.reporting.MeasurementUnit

All Implemented Interfaces:

Serializable
```
public class MeasurementUnit
extends Object
implements Serializable
```
A result of the smallest measurement unit - an iteration. One should obtain a new instance of a MeasurementUnit using ReportManager.newMeasurementUnit().

Author:

Martin Večeřa

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendResult(String label, Object value)` Appends a custom result.
`boolean`	`equals(Object obj)`
`long`	`getEnqueueTime()` Gets the time when the current sender request was enqueued.
`Exception`	`getFailure()` Gets the failure that happened during processing of this task.
`long`	`getIteration()` Gets the number of current iteration of this Measurement Unit.
`double`	`getLastTime()` Gets time of the last measurement (time period between calls to `startMeasure()` and `stopMeasure()` in milliseconds.
`Object`	`getResult(String label)` Gets a custom result for the given label.
`Map<String,Object>`	`getResults()` Gets immutable map with all the custom results.
`double`	`getServiceTime()` Gets the total service time between enqueuing the sender task and its completion.
`long`	`getStartTime()` Gets the start time of the measurement in nanoseconds.
`long`	`getStopTime()` Gets the stop time of the measurement in nanoseconds.
`double`	`getTotalTime()` Gets total time measured during all measurements done by this Measurement Unit (all time periods between calls to `startMeasure()` and `stopMeasure()` in milliseconds.
`int`	`hashCode()`
`void`	`setEnqueueTime(long enqueueTime)` Sets the time when the current sender request was enqueued.
`void`	`setFailure(Exception failure)` Sets the exception that happened during processing of this task to be remembered and reported.
`boolean`	`startedAfter(long ref)` Checks whether this measurement unit was first started after the specified time (Unix time in millis).
`void`	`startMeasure()` Starts measuring.
`void`	`stopMeasure()` Stops measuring.
`static MeasurementUnit`	`streamIn(ObjectInputStream in)` Reads the minimalistic serialization of Measurement Unit from the input stream.
`void`	`streamOut(ObjectOutputStream oos)` Writes this instance into output stream with a minimum data needed.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - appendResult
```
public void appendResult(String label,
                         Object value)
```
    Appends a custom result.
    
    Parameters:
    
    label - The label of the result.
    
    value - The value of the result.
  - getResults
```
public Map<String,Object> getResults()
```
    Gets immutable map with all the custom results.
    
    Returns:
    
    An immutable copy of the custom results map.
  - getResult
```
public Object getResult(String label)
```
    Gets a custom result for the given label.
    
    Parameters:
    
    label - The label of the custom result.
    
    Returns:
    
    The value for the given custom result.
  - startMeasure
```
public void startMeasure()
```
    Starts measuring. This is independent on current system time.
  - stopMeasure
```
public void stopMeasure()
```
    Stops measuring.
  - getTotalTime
```
public double getTotalTime()
```
    Gets total time measured during all measurements done by this Measurement Unit (all time periods between calls to startMeasure() and stopMeasure() in milliseconds.
    
    Returns:
    
    The total time measured by this unit in milliseconds.
  - getStartTime
```
public long getStartTime()
```
    Gets the start time of the measurement in nanoseconds.
    
    Returns:
    
    The start time of the measurement in nanoseconds.
  - getStopTime
```
public long getStopTime()
```
    Gets the stop time of the measurement in nanoseconds.
    
    Returns:
    
    The stop time of the measurement in nanoseconds.
  - getLastTime
```
public double getLastTime()
```
    Gets time of the last measurement (time period between calls to startMeasure() and stopMeasure() in milliseconds.
    
    Returns:
    
    Time of the last measurement in milliseconds, -1 when there was no measurement recorded yet.
  - getServiceTime
```
public double getServiceTime()
```
    Gets the total service time between enqueuing the sender task and its completion.
    
    Returns:
    
    The total service time between enqueuing the sender task and its completion, -1 when there was no measurement recorded yet.
  - startedAfter
```
public boolean startedAfter(long ref)
```
    Checks whether this measurement unit was first started after the specified time (Unix time in millis).
    
    Parameters:
    
    ref - The reference time to compare to the start of the measurement.
    
    Returns:
    
    true if this measurement unit was first started after the specified reference time.
  - getIteration
```
public long getIteration()
```
    Gets the number of current iteration of this Measurement Unit.
    
    Returns:
    
    The number of iteration.
  - getFailure
```
public Exception getFailure()
```
    Gets the failure that happened during processing of this task.
    
    Returns:
    
    The exception that occurred or null if there was no exception.
  - setFailure
```
public void setFailure(Exception failure)
```
    Sets the exception that happened during processing of this task to be remembered and reported.
    
    Parameters:
    
    failure - The exception that happened or null to clear the failure flag.
  - getEnqueueTime
```
public long getEnqueueTime()
```
    Gets the time when the current sender request was enqueued.
    
    Returns:
    
    The time when the current sender request was enqueued.
  - setEnqueueTime
```
public void setEnqueueTime(long enqueueTime)
```
    Sets the time when the current sender request was enqueued.
    
    Parameters:
    
    enqueueTime - The time when the current sender request was enqueued.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - streamOut
```
public void streamOut(ObjectOutputStream oos)
               throws IOException
```
    Writes this instance into output stream with a minimum data needed. This serves for easy transfer of serialized Mesurement Units.
    
    Parameters:
    
    oos - Stream to write the data to.
    
    Throws:
    
    IOException - When there was an error writing the data.
  - streamIn
```
public static MeasurementUnit streamIn(ObjectInputStream in)
                                throws ClassNotFoundException,
                                       IOException
```
    Reads the minimalistic serialization of Measurement Unit from the input stream.
    
    Parameters:
    
    in - The stream to read the object data from.
    
    Returns:
    
    The deserialized MeasurementUnit.
    
    Throws:
    
    ClassNotFoundException - When it is not possible to restore an unknown class from the data.
    
    IOException - When there was an I/O error reading data.

Class MeasurementUnit

Method Summary

Methods inherited from class java.lang.Object

Method Detail

appendResult

getResults

getResult

startMeasure

stopMeasure

getTotalTime

getStartTime

getStopTime

getLastTime

getServiceTime

startedAfter

getIteration

getFailure

setFailure

getEnqueueTime

setEnqueueTime

hashCode

equals

toString

streamOut

streamIn