com.endeca.infront.perf.stats

Class EventInfo

java.lang.Object

com.endeca.infront.perf.stats.EventInfo

Direct Known Subclasses:

RootEventInfo

public class EventInfo
extends Object

Simple structure to keep track of information related to some event.

This class is part of the implementation of StatsCollectionHandler and is not meant to be instantiated directly.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDepth()
String	getDescription()
long	getLocalTime()
String	getTopic()
long	getTotalTime()
boolean	succeeded()

Methods inherited from class java.lang.Object

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

Method Detail

getTopic

public String getTopic()

Returns:

The topic of this event

getDescription

public String getDescription()

Returns:

A description of this event, or null if not supplied

getTotalTime

public long getTotalTime()

Returns:

The total time spent in the event or its descendant events (in microseconds)

getLocalTime

public long getLocalTime()

Returns:

The time spent in the event, excluding time spent in descendant events (in microseconds)

getDepth

public int getDepth()

Returns:

The depth of this event in the event stack (with 0 being the root event)

succeeded

public boolean succeeded()

Returns:

Whether the event in question finished successfully