com.sun.management.jmx
Class TraceListener

java.lang.Object
  |
  +--com.sun.management.jmx.TraceListener

public class TraceListener
extends java.lang.Object
implements NotificationListener

An object of this class can be used to receive notifications sent out by the class Trace, and all notifications received will be saved to a file specified, or write to user screen. This listener will print or save information with two formats:

This class can be used as a default listener, a user can write his own listener to treat trace information the way he wants.


Field Summary
protected  boolean formated
           
protected  boolean needTobeClosed
           
protected  java.io.PrintStream out
           
 
Constructor Summary
TraceListener()
          Construct a default trace listener.
TraceListener(java.io.PrintStream ps)
          Construct a trace listener with a specified output stream.
TraceListener(java.lang.String fileName)
          Construct a trace listener with a file specified to save all information received.
 
Method Summary
 void handleNotification(Notification notif, java.lang.Object handback)
          Called by the class Trace to receive trace information.
 void setFile(java.lang.String fileName)
          Specify a file to save information received
 void setFormated(boolean f)
          Choose a format to output trace information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

out

protected java.io.PrintStream out

needTobeClosed

protected boolean needTobeClosed

formated

protected boolean formated
Constructor Detail

TraceListener

public TraceListener()
Construct a default trace listener. All information will printed on screen (System.out) with the format:

(className methodName) message.


TraceListener

public TraceListener(java.io.PrintStream ps)
              throws java.lang.IllegalArgumentException
Construct a trace listener with a specified output stream.
Parameters:
ps - a PrintStream object used to print trace information.

For example, it can take value as System.out or System.err.

ps - An PrintStream object used to print out trace information.
Throws:
java.lang.IllegalArgumentException - thrown if the parameter ps is null.

TraceListener

public TraceListener(java.lang.String fileName)
              throws java.io.IOException
Construct a trace listener with a file specified to save all information received.

If specified file exists currently, all trace information will be appended to this file.

Parameters:
fileName - the file used to save information.
Throws:
java.io.IOException - thrown if failed to open or write the file.
Method Detail

setFormated

public void setFormated(boolean f)
Choose a format to output trace information.
Parameters:
f - if true, the completed format will be selected.

handleNotification

public void handleNotification(Notification notif,
                               java.lang.Object handback)
Called by the class Trace to receive trace information.
Specified by:
handleNotification in interface NotificationListener
Tags copied from interface: NotificationListener
Parameters:
notification - The notification.
handback - An opaque object which helps the listener to associate information regarding the MBean emitter. This object is passed to the MBean during the addListener call and resent, without modification, to the listener. The MBean object should not use or modify the object.

setFile

public void setFile(java.lang.String fileName)
             throws java.io.IOException
Specify a file to save information received
Parameters:
fileName - the file used to save information. It will replace the old file or the PrintStream object setted before.
Throws:
java.io.IOException - thrown if failed to open or to write the file.