wt.util
Interface TraceTimingLogger

All Known Subinterfaces:

TraceTimingRepositoryLogger

All Known Implementing Classes:

AbstractProfilingLogger, TraceTimingRepository, TraceTimingThreadedLogger, TraceTimingThreadedRepository

public interface TraceTimingLogger

This interface specifies the methods for logging and retrieving Trace Timing entries.

Supported API: false

Extendable: false

Field Summary

static String

PROPERTY_MAP Label for the attribute; Property map used to control the behavior of the Logger.

Method Summary

TraceTimingEntry	addBeginEntry(String a_className, String a_name, long a_timeMillis, Object a_info) Adds a begin entry to the log.
TraceTimingEntry	addBreakEntry(String a_className, String a_name, long a_timeMillis, Object a_info, int a_level) Adds an break-in-flow, end entry to the log.
TraceTimingEntry	addEndEntry(String a_className, String a_name, long a_timeMillis, Object a_info) Adds an end entry to the log.
Map	getPropertyMap() Gets the value of the attribute: PROPERTY_MAP.
void	setPropertyMap(Map a_PropertyMap) Sets the value of the attribute: PROPERTY_MAP.

Field Detail

PROPERTY_MAP

public static final String PROPERTY_MAP

Label for the attribute; Property map used to control the behavior of the Logger.

Supported API: false

See Also:

Constant Field Values

Method Detail

getPropertyMap

public Map getPropertyMap()

Gets the value of the attribute: PROPERTY_MAP. Property map used to control the behavior of the Logger.

Supported API: false

Returns:

Map

setPropertyMap

public void setPropertyMap(Map a_PropertyMap)
                    throws WTPropertyVetoException

Sets the value of the attribute: PROPERTY_MAP. Property map used to control the behavior of the Logger.

Supported API: false

Parameters:

a_PropertyMap -

Throws:

WTPropertyVetoException

addBeginEntry

public TraceTimingEntry addBeginEntry(String a_className,
                                      String a_name,
                                      long a_timeMillis,
                                      Object a_info)

Adds a begin entry to the log.

Supported API: false

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

Returns:

TraceTimingEntry

addEndEntry

public TraceTimingEntry addEndEntry(String a_className,
                                    String a_name,
                                    long a_timeMillis,
                                    Object a_info)

Adds an end entry to the log.

Supported API: false

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

Returns:

TraceTimingEntry

addBreakEntry

public TraceTimingEntry addBreakEntry(String a_className,
                                      String a_name,
                                      long a_timeMillis,
                                      Object a_info,
                                      int a_level)

Adds an break-in-flow, end entry to the log.

Supported API: false

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

a_level - Indicates the level of the corresponding begin entry.

Returns:

TraceTimingEntry