com.ibm.zosconnect.buildtoolkit

Class Trace

java.lang.Object

com.ibm.zosconnect.buildtoolkit.Trace

public class Trace
extends java.lang.Object

Utility for outputting verbose information about the build toolkit functionality.

Method Summary

Modifier and Type	Method and Description
static void	active() Turn on the output of trace messages.
static void	deactivate() Turn off the output of trace messages.
static void	exception(java.lang.Object owner, java.lang.String method, java.lang.Throwable exception) Used to mark that an exception has been caught.
static void	in(java.lang.Object owner, java.lang.String method, java.lang.Object... parameters) Used to mark the start of a method.
static void	message(java.lang.Object owner, java.lang.String method, java.lang.String message, java.lang.Object... inserts) Used to output an information message.
static void	out(java.lang.Object owner, java.lang.String method) Used to mark that a method has returned.
static void	out(java.lang.Object owner, java.lang.String method, java.lang.Object returnVal) Used to mark that a method has returned.
static void	setOutput(java.io.PrintStream out) Set the location that trace messages should be written to.

Methods inherited from class java.lang.Object

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

Method Detail

in

public static void in(java.lang.Object owner,
                      java.lang.String method,
                      java.lang.Object... parameters)

Used to mark the start of a method.

Parameters:

owner - The object which owns the method.

method - The name of the method.

parameters - The parameters passed to the method.

out

public static void out(java.lang.Object owner,
                       java.lang.String method)

Used to mark that a method has returned. This method should be used in methods that don't have a return value.

Parameters:

owner - The object which owns the method.

method - The name of the method.

out

public static void out(java.lang.Object owner,
                       java.lang.String method,
                       java.lang.Object returnVal)

Used to mark that a method has returned.

Parameters:

owner - The object which owns the method.

method - The name of the method.

returnVal - The value the method is returning.

exception

public static void exception(java.lang.Object owner,
                             java.lang.String method,
                             java.lang.Throwable exception)

Used to mark that an exception has been caught.

Parameters:

owner - The object which is tracing the exception.

method - The name of the method which caught the exception.

exception - The exception that was caught.

message

public static void message(java.lang.Object owner,
                           java.lang.String method,
                           java.lang.String message,
                           java.lang.Object... inserts)

Used to output an information message.

Parameters:

owner - The object which is tracing the message.

method - The name of the method tracing the message.

message - The message to be traced.

inserts - Any inserts to be put in the traced message.

active

public static void active()

Turn on the output of trace messages.

deactivate

public static void deactivate()

Turn off the output of trace messages.

setOutput

public static void setOutput(java.io.PrintStream out)

Set the location that trace messages should be written to.

Parameters:

out - The PrintStream to write trace messages to.