ca.intelliware.amakihi.util.performance
Class PerformanceMeasure

java.lang.Object
  |
  +--ca.intelliware.amakihi.util.performance.PerformanceMeasure

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class PerformanceMeasure

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

This class is used to take a performance snapshot of a system over a certain interval.

Version:

$Revision: 1.3 $

Author:

Intelliware Development

See Also:

Serialized Form

Constructor Summary

PerformanceMeasure()
PerformanceMeasure constructor comment.

Method Summary

java.lang.Object	clone() Insert the method's description here.
void	end() Insert the method's description here.
void	end(boolean error) Insert the method's description here.
void	end(java.lang.Exception exception)
java.util.Date	getEndDate() Insert the method's description here.
java.lang.Exception	getException()
long	getPerformanceTime() Insert the method's description here.
java.lang.String	getRequestName() Gets the requestName
java.util.Date	getStartDate() Insert the method's description here.
java.lang.String	getTag() Gets the tag
static java.util.Date	getTestSuiteStartDate() Returns the date that the performance measure was instantiated.
boolean	isError() Insert the method's description here.
void	setRequestName(java.lang.String requestName) Sets the requestName
void	setTag(java.lang.String tag) Sets the tag
void	start() Start an interval for which a performance measure is desired.
java.lang.String	toString() Insert the method's description here.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformanceMeasure

public PerformanceMeasure()

PerformanceMeasure constructor comment.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Insert the method's description here.

Overrides:

clone in class java.lang.Object

Returns:

java.lang.Object

end

public void end()

Insert the method's description here.

end

public void end(boolean error)

Insert the method's description here.

end

public void end(java.lang.Exception exception)

getEndDate

public java.util.Date getEndDate()

Insert the method's description here.

Returns:

java.util.Date

getPerformanceTime

public long getPerformanceTime()

Insert the method's description here.

Returns:

long

getStartDate

public java.util.Date getStartDate()

Insert the method's description here.

Returns:

java.util.Date

getTestSuiteStartDate

public static java.util.Date getTestSuiteStartDate()

Returns the date that the performance measure was instantiated. The instantiation date can be used to

Returns:

java.util.Date

isError

public boolean isError()

Insert the method's description here.

Returns:

boolean

getException

public java.lang.Exception getException()

start

public void start()

Start an interval for which a performance measure is desired. This method takes a snapshot of the environment (current date/time, memory, etc.);

See Also:

end()

toString

public java.lang.String toString()

Insert the method's description here.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String

getRequestName

public java.lang.String getRequestName()

Gets the requestName

Returns:

Returns a String

setRequestName

public void setRequestName(java.lang.String requestName)

Sets the requestName

Parameters:

requestName - The requestName to set

getTag

public java.lang.String getTag()

Gets the tag

Returns:

Returns a String

setTag

public void setTag(java.lang.String tag)

Sets the tag

Parameters:

tag - The tag to set