Package org.eclipse.ecf.core.util
Class Trace
java.lang.Object
org.eclipse.ecf.core.util.Trace
A utility for tracing debug information. Provides a simple interface for
filtering and generating trace output.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final StringLabel indicating new value.protected static final StringLabel indicating old value.protected static final StringString containing a close parenthesis.protected static final StringString containing an open parenthesis.protected static final StringPrefix for tracing the catching of throwables.protected static final StringPrefix for tracing the changing of values.protected static final StringPrefix for tracing the entering of methods.protected static final StringPrefix for tracing the exiting of methods.protected static final StringPrefix for tracing the throwing of throwables.protected static final StringPrefix for tracing the changing of values.protected static final StringSeparator for methods.protected static final StringSeparator for parameters.protected static final StringSeparator for return values.protected static final StringSeparator containing a space.protected static final StringString containing TRACE -
Method Summary
Modifier and TypeMethodDescriptionstatic voidTraces the catching of the specified throwable in the specified method of the specified class.static voidchanging(String pluginId, String option, Class clazz, String methodName, String valueDescription, Object oldValue, Object newValue) static voidTraces the changing of a value.static voidTraces the entering into the specified method of the specified class.static voidTraces the entering into the specified method of the specified class, with the specified parameter.static voidTraces the entering into the specified method of the specified class, with the specified parameters.static voidTraces the exiting from the specified method of the specified class.static voidTraces the exiting from the specified method of the specified class, with the specified return value.static StringgetArgumentsString(Object[] arguments) Retrieves a textual representation of the specified arguments.static StringgetArgumentString(Object argument) Retrieves a textual representation of the specified argument.protected static StringGet date and time stringprotected static booleanshouldTrace(String pluginId) Retrieves a Boolean value indicating whether tracing is enabled for the specified plug-in.static booleanshouldTrace(String pluginId, String option) Retrieves a Boolean value indicating whether tracing is enabled for the specified debug option of the specified plug-in.protected static booleanshouldTrace0(String option) static voidTraces the throwing of the specified throwable from the specified method of the specified class.protected static voidTraces the specified message.static voidTraces the specified message from the specified plug-in.static voidTraces the specified message from the specified plug-in for the specified debug option.static voidTraces the specified message from the specified plug-in for the specified debug option.
-
Field Details
-
PARENTHESIS_OPEN
String containing an open parenthesis.- See Also:
-
PARENTHESIS_CLOSE
String containing a close parenthesis.- See Also:
-
TRACE_STR
String containing TRACE- See Also:
-
PREFIX_TRACING
Prefix for tracing the changing of values.- See Also:
-
PREFIX_CHANGING
Prefix for tracing the changing of values.- See Also:
-
PREFIX_CATCHING
Prefix for tracing the catching of throwables.- See Also:
-
PREFIX_THROWING
Prefix for tracing the throwing of throwables.- See Also:
-
PREFIX_ENTERING
Prefix for tracing the entering of methods.- See Also:
-
PREFIX_EXITING
Prefix for tracing the exiting of methods.- See Also:
-
SEPARATOR_METHOD
Separator for methods.- See Also:
-
SEPARATOR_PARAMETER
Separator for parameters.- See Also:
-
SEPARATOR_RETURN
Separator for return values.- See Also:
-
SEPARATOR_SPACE
Separator containing a space.- See Also:
-
LABEL_OLD_VALUE
Label indicating old value.- See Also:
-
LABEL_NEW_VALUE
Label indicating new value.- See Also:
-
-
Method Details
-
shouldTrace
Retrieves a Boolean value indicating whether tracing is enabled for the specified plug-in.- Parameters:
pluginId- The symbolic plugin id for which to determine trace enablement.- Returns:
- Whether tracing is enabled for the plug-in.
-
shouldTrace0
-
shouldTrace
Retrieves a Boolean value indicating whether tracing is enabled for the specified debug option of the specified plug-in.- Parameters:
pluginId- The plug-in for which to determine trace enablement.option- The debug option for which to determine trace enablement.- Returns:
- Whether tracing is enabled for the debug option of the plug-in.
-
getArgumentString
Retrieves a textual representation of the specified argument.- Parameters:
argument- The argument for which to retrieve a textual representation.- Returns:
- A textual representation of the specified argument.
-
getArgumentsString
Retrieves a textual representation of the specified arguments.- Parameters:
arguments- The arguments for which to retrieve a textual representation.- Returns:
- A textual representation of the specified arguments.
-
trace
Traces the specified message.- Parameters:
message- The message to be traced.
-
getTimeString
Get date and time string- Returns:
- String with current date and time
-
trace
Traces the specified message from the specified plug-in.- Parameters:
pluginId- The plug-in from which to trace.message- The message to be traced.
-
trace
Traces the specified message from the specified plug-in for the specified debug option.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.message- The message to be traced.
-
trace
public static void trace(String pluginId, String option, Class clazz, String methodName, String message) Traces the specified message from the specified plug-in for the specified debug option.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being entered.methodName- The name of method that is being entered.message- The message to be traced.
-
changing
public static void changing(String pluginId, String option, String valueDescription, Object oldValue, Object newValue) Traces the changing of a value.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.valueDescription- The description of the value which is changing.oldValue- The old value.newValue- The new value.
-
changing
public static void changing(String pluginId, String option, Class clazz, String methodName, String valueDescription, Object oldValue, Object newValue) - Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class in which the value is changing.methodName- The name of the method in which the value is changing.valueDescription- The description of the value which is changing.oldValue- The old value.newValue- The new value.
-
catching
public static void catching(String pluginId, String option, Class clazz, String methodName, Throwable throwable) Traces the catching of the specified throwable in the specified method of the specified class.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class in which the throwable is being caught.methodName- The name of the method in which the throwable is being caught.throwable- The throwable that is being caught.
-
throwing
public static void throwing(String pluginId, String option, Class clazz, String methodName, Throwable throwable) Traces the throwing of the specified throwable from the specified method of the specified class.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class from which the throwable is being thrown.methodName- The name of the method from which the throwable is being thrown.throwable- The throwable that is being thrown.
-
entering
Traces the entering into the specified method of the specified class.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being entered.methodName- The name of method that is being entered.
-
entering
public static void entering(String pluginId, String option, Class clazz, String methodName, Object parameter) Traces the entering into the specified method of the specified class, with the specified parameter.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being entered.methodName- The name of method that is being entered.parameter- The parameter to the method being entered.
-
entering
public static void entering(String pluginId, String option, Class clazz, String methodName, Object[] parameters) Traces the entering into the specified method of the specified class, with the specified parameters.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being entered.methodName- The name of method that is being entered.parameters- The parameters to the method being entered.
-
exiting
Traces the exiting from the specified method of the specified class.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being exited.methodName- The name of method that is being exited.
-
exiting
public static void exiting(String pluginId, String option, Class clazz, String methodName, Object returnValue) Traces the exiting from the specified method of the specified class, with the specified return value.- Parameters:
pluginId- The plug-in from which to trace.option- The debug option for which to trace.clazz- The class whose method is being exited.methodName- The name of method that is being exited.returnValue- The return value of the method being exited.
-