com.ibm.commerce.ras

Class MethodExitLogEvent



  • public class MethodExitLogEvent
    extends MethodLogEvent
    MethodExitLogEvent class is used to define the message text recording the exit from a method.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      MethodExitLogEvent(java.sql.Timestamp time, java.lang.String thread, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName)
      Constructor for MethodExitLogEvent.
      MethodExitLogEvent(java.sql.Timestamp time, java.lang.String thread, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName, java.lang.Object retValue)
      Constructor for MethodExitLogEvent.
      MethodExitLogEvent(java.sql.Timestamp time, java.lang.String thread, java.lang.String clientId, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName)
      Constructor for MethodExitLogEvent.
      MethodExitLogEvent(java.sql.Timestamp time, java.lang.String thread, java.lang.String clientId, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName, java.lang.Object retValue)
      Constructor for MethodExitLogEvent.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String createMessageBody()
      Creates the message body.
      java.lang.String getCompactMessageBody()
      Gets the message body in compact format.
      java.lang.String getMessageBody()
      Gets the message body in detailed format.
      void print()
      Print out the message text in specified output manager
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MethodExitLogEvent

        public MethodExitLogEvent(java.sql.Timestamp time,
                                  java.lang.String thread,
                                  IOutputManager outputMgr,
                                  java.lang.String aComponentName,
                                  java.lang.String aClassName,
                                  java.lang.String aMethodName)
        Constructor for MethodExitLogEvent.
        Parameters:
        time - the timestamp of the trace entry
        thread - the thread that entry is generated by
        outputMgr - output device to write the logs
        aComponentName - trace component the entry belongs to
        aClassName - class name that generates the entry
        aMethodName - method name that generates the entry
      • MethodExitLogEvent

        public MethodExitLogEvent(java.sql.Timestamp time,
                                  java.lang.String thread,
                                  IOutputManager outputMgr,
                                  java.lang.String aComponentName,
                                  java.lang.String aClassName,
                                  java.lang.String aMethodName,
                                  java.lang.Object retValue)
        Constructor for MethodExitLogEvent.
        Parameters:
        time - the timestamp of the trace entry
        thread - the thread that entry is generated by
        outputMgr - output device to write the logs
        aComponentName - trace component the entry belongs to
        aClassName - class name that generates the entry
        aMethodName - method name that generates the entry
        retValue - the return object to include more debug info
      • MethodExitLogEvent

        public MethodExitLogEvent(java.sql.Timestamp time,
                                  java.lang.String thread,
                                  java.lang.String clientId,
                                  IOutputManager outputMgr,
                                  java.lang.String aComponentName,
                                  java.lang.String aClassName,
                                  java.lang.String aMethodName)
        Constructor for MethodExitLogEvent.
        Parameters:
        time - the timestamp of the trace entry
        thread - the thread that entry is generated by
        clientId - the unique Id to represent the client; used to debug double click problem
        outputMgr - output device to write the logs
        aComponentName - trace component the entry belongs to
        aClassName - class name that generates the entry
        aMethodName - method name that generates the entry
      • MethodExitLogEvent

        public MethodExitLogEvent(java.sql.Timestamp time,
                                  java.lang.String thread,
                                  java.lang.String clientId,
                                  IOutputManager outputMgr,
                                  java.lang.String aComponentName,
                                  java.lang.String aClassName,
                                  java.lang.String aMethodName,
                                  java.lang.Object retValue)
        Constructor for MethodExitLogEvent.
        Parameters:
        time - the timestamp of the trace entry
        thread - the thread that entry is generated by
        clientId - the unique Id to represent the client; used to debug double click problem
        outputMgr - output device to write the logs
        aComponentName - trace component the entry belongs to
        aClassName - class name that generates the entry
        aMethodName - method name that generates the entry
        retValue - the return object to include more debug info
    • Method Detail

      • createMessageBody

        public java.lang.String createMessageBody()
        Creates the message body. The message body can be in either detailed or compact format.
        Overrides:
        createMessageBody in class MethodLogEvent
        Returns:
        formatted message body
      • getCompactMessageBody

        public java.lang.String getCompactMessageBody()
        Gets the message body in compact format.
        Overrides:
        getCompactMessageBody in class MethodLogEvent
        Returns:
        the message text in compact format
      • getMessageBody

        public java.lang.String getMessageBody()
        Gets the message body in detailed format.
        Overrides:
        getMessageBody in class MethodLogEvent
        Returns:
        the message text in detailed format
      • print

        public void print()
        Print out the message text in specified output manager