Changeset 1492

Timestamp:

06/06/09 13:36:19 (3 years ago)

Author:

amandel

Message:

Add new way to get Loggable dump with nested parameters.

Location:

trunk/src/java/org/jcoderz/commons

Files:

• BaseException.java (modified) (2 diffs)
• BaseRuntimeException.java (modified) (2 diffs)
• LogEvent.java (modified) (1 diff)
• Loggable.java (modified) (2 diffs)
• LoggableImpl.java (modified) (11 diffs)
• util/ThrowableUtil.java (modified) (4 diffs)

trunk/src/java/org/jcoderz/commons/BaseException.java

@@ -37 +37 @@
 import java.util.List;
 import java.util.Set;
-import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -199 +198 @@
    public String toString ()
    {
-       return mLoggable.toString();
+      return mLoggable.toString();
+   }
+
+   /** {@inheritDoc} */
+   public String toDetailedString ()
+   {
+      return mLoggable.toDetailedString();
    }
 

trunk/src/java/org/jcoderz/commons/BaseRuntimeException.java

@@ -37 +37 @@
 import java.util.List;
 import java.util.Set;
-import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -198 +197 @@
    public String toString ()
    {
-       return mLoggable.toString();
+      return mLoggable.toString();
+   }
+
+   /** {@inheritDoc} */
+   public String toDetailedString ()
+   {
+      return mLoggable.toDetailedString();
    }
 

trunk/src/java/org/jcoderz/commons/LogEvent.java

@@ -182 +182 @@
    }
 
+   /** {@inheritDoc} */
+   public String toString ()
+   {
+      return mLoggable.toString();
+   }
+
+   /** {@inheritDoc} */
+   public String toDetailedString ()
+   {
+      return mLoggable.toDetailedString();
+   }
+
+
    LoggableImpl getExceptionImpl ()
    {

trunk/src/java/org/jcoderz/commons/Loggable.java

@@ -170 +170 @@
 
    /**
+    * The toString method of <code>Loggable</code> dumps the
+    * String representation of the class name of the loggable
+    * and the contained message.
+    * @return one line information about this <code>Loggable</code>.
+    */
+   String toString ();
+
+   /**
     * The toString method of <code>Loggable</code> must dump out all
     * information stored within this loggable in a readable way. This
@@ -176 +184 @@
     *       <code>Loggable</code>.
     */
-   String toString ();
+   String toDetailedString ();
 
    /**

trunk/src/java/org/jcoderz/commons/LoggableImpl.java

@@ -38 +38 @@
 import java.net.UnknownHostException;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -182 +184 @@
    private final String mThreadName;
 
-   /** The Throwable that caused this loggable. */
+   /**
+    * The Throwable that caused this loggable.
+    * Should be equal to mOuter.getCause()
+    */
    private Throwable mCause;
 
@@ -196 +201 @@
    }
 
+   /**
+    * Create this loggable provide the 'Loggable' functionality for the
+    * given outer loggable.
+    * @param outer the the outer loggable.
+    * @param errorId the static LogMessageInfo for this Loggable.
+    */
    public LoggableImpl (Loggable outer, LogMessageInfo errorId)
    {
@@ -202 +213 @@
    }
 
+   /**
+    * Create this loggable provide the 'Loggable' functionality for the
+    * given outer loggable with an initial cause.
+    * @param outer the the outer loggable.
+    * @param errorId the static LogMessageInfo for this Loggable.
+    * @param cause the cause of the outer.
+    */
    public LoggableImpl (Loggable outer, LogMessageInfo errorId,
        Throwable cause)
@@ -210 +228 @@
    }
 
+   /**
+    * Create this loggable provide the 'Loggable' functionality for the
+    * given outer loggable with the given dynamic parameters.
+    * @param outer the the outer loggable.
+    * @param errorId the static LogMessageInfo for this Loggable.
+    * @param threadId the threadId to be set.
+    * @param threadName the threadName to be set.
+    * @param instanceId the instanceId to be set.
+    * @param nodeId the nodeId to be set.
+    */
    public LoggableImpl (Loggable outer, LogMessageInfo errorId,
        long threadId, String threadName, String instanceId, String nodeId)
@@ -224 +252 @@
    }
 
+   /**
+    * Create this loggable provide the 'Loggable' functionality for the
+    * given outer loggable with the given dynamic parameters and an
+    * initial cause..
+    * @param outer the the outer loggable.
+    * @param errorId the static LogMessageInfo for this Loggable.
+    * @param threadId the threadId to be set.
+    * @param threadName the threadName to be set.
+    * @param instanceId the instanceId to be set.
+    * @param nodeId the nodeId to be set.
+    * @param cause the cause of the outer.
+    */
    public LoggableImpl (Loggable outer, LogMessageInfo errorId,
        long threadId, String threadName, String instanceId, String nodeId,
@@ -229 +269 @@
    {
       mEventTime = System.currentTimeMillis();
-      if (cause instanceof Loggable)
-      {
-         mTrackingNumber = ((Loggable) cause).getTrackingNumber();
+      ThrowableUtil.fixChaining(cause);
+      Throwable thr = cause;
+      while (thr != null && !(thr instanceof Loggable))
+      {
+          thr = thr.getCause();
+      }
+      if (thr instanceof Loggable)
+      {
+         mTrackingNumber = ((Loggable) thr).getTrackingNumber();
       }
       else
@@ -396 +442 @@
       getLogMessageInfo().formatMessage(mParameters, sb);
       return sb.toString();
+   }
+
+   /** {@inheritDoc} */
+   public String toDetailedString ()
+   {
+       final StringBuffer sb = new StringBuffer();
+       LoggableImpl.appendParameters(sb, this);
+       Throwable cause = null;
+       if (mOuter != null)
+       {
+           cause = mOuter.getCause();
+       }
+       if (cause == null)
+       {
+           cause = getCause();
+       }
+       // add parameters of nested chain
+       while (cause != null)
+       {
+           if (cause instanceof Loggable)
+           {
+               sb.append("\nCaused by: ");
+               LoggableImpl.appendParameters(sb, (Loggable) cause);
+               break;
+           }
+           cause = cause.getCause();
+       }
+       cause = null;
+       if (mOuter != null)
+       {
+           cause = mOuter.getCause();
+       }
+       if (cause == null)
+       {
+           cause = getCause();
+       }
+       if (cause != null)
+       {
+           sb.append('\n');
+           sb.append(ThrowableUtil.toString(cause));
+       }
+       return sb.toString();
    }
 
@@ -417 +505 @@
       if (mMethodName == null || mClassName == null)
       {
-          final StackTraceElement[] stack = (new Throwable()).getStackTrace();
+          final StackTraceElement[] stack = new Throwable().getStackTrace();
           // First, search back to a method in the Logger class.
           int ix = 0;
@@ -486 +574 @@
    }
 
+   private static void appendParameters (StringBuffer sb, Loggable loggable)
+   {
+       sb.append(loggable.toString());
+
+       final Object[] params = loggable.getParameterNames().toArray();
+       Arrays.sort(params);
+       final Iterator/*<String>*/ parameterNames
+           = Arrays.asList(params).iterator();
+       while(parameterNames.hasNext())
+       {
+           final String parameterName = (String) parameterNames.next();
+           sb.append("\n\t");
+           sb.append(parameterName);
+           sb.append(": \t");
+           sb.append(loggable.getParameter(parameterName));
+       }
+   }
+
    private static String getStaticNodeId ()
    {
@@ -523 +629 @@
       }
    }
+
+
 }

trunk/src/java/org/jcoderz/commons/util/ThrowableUtil.java

@@ -33 +33 @@
 package org.jcoderz.commons.util;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
@@ -47 +49 @@
 public final class ThrowableUtil
 {
-   /** 
+   /**
     * Stores the Throwable.getCause() method if this method is available.
-    * This should be the case for all JDKs > 1.4. 
+    * This should be the case for all JDKs > 1.4.
     */
    private static final Method GET_CAUSE;
-   /** 
-    * Stores the Throwable.initCause(Throwable) method if this method 
+   /**
+    * Stores the Throwable.initCause(Throwable) method if this method
     * is available.
-    * This should be the case for all JDKs > 1.4. 
+    * This should be the case for all JDKs > 1.4.
     */
    private static final Method INIT_CAUSE;
@@ -99 +101 @@
     * classes and pass the nested exceptions into the standart
     * nesting mechanism available since JDK1.4 with the throwable
-    * class. It is save to call this method several times for a 
+    * class. It is save to call this method several times for a
     * give exception.
     * @param ex the exception to be checked.
@@ -139 +141 @@
    }
 
+   /**
+    * Dumps the stack trace of the given throwable to its String representation.
+    * @param thr the throwable to dump the stack trace from.
+    * @return a String representation of the given throwable
+    * @see Throwable#printStackTrace()
+    */
+   public static String toString (Throwable thr)
+   {
+       final StringWriter sw = new StringWriter();
+       PrintWriter pw = null;
+       try
+       {
+           pw = new PrintWriter(sw);
+           thr.printStackTrace(pw);
+       }
+       finally
+       {
+           IoUtil.close(pw);
+           IoUtil.close(sw);
+       }
+       return sw.toString();
+   }
+
    static Method findGetCauseMethod (final Method[] methods)
    {