Changeset 1557

Timestamp:

10/08/09 19:07:58 (3 years ago)

Author:

amandel

Message:

- add serial version uids
- support from arrays / base type arrays in toString
- add data of nested loggables

Location:

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

Files:

• ArraysUtil.java (modified) (4 diffs)
• BigDecimalUserTypeBase.java (modified) (1 diff)
• IntUserTypeBase.java (modified) (1 diff)
• LoggingProxy.java (modified) (3 diffs)
• LongUserTypeBase.java (modified) (1 diff)
• StringUserTypeBase.java (modified) (1 diff)
• StringUtil.java (modified) (1 diff)
• ThrowableUtil.java (modified) (1 diff)
• UserTypeBase.java (modified) (1 diff)

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

@@ -35 +35 @@
 
 
+
 /**
  * This class contains a static factory that allows arrays to be viewed as
@@ -50 +51 @@
       // No instances allowed - contains only static utility functions.
    }
-   
-   
+
+   /**
+    * Returns a string representation of the contents of given
+    * object with special care for potential arrays.
+    * For none array objects the toString method is invoked, for
+    * arrays the content of the array is converted.
+    *  
+    * If the array contains other arrays as elements, they are converted 
+    * to strings by the {@link Object#toString}method inherited 
+    * from <tt>Object</tt>, which describes their <i>identities</i> 
+    * rather than their contents.
+    * <p>
+    * The value returned by this method is equal to the value that would be
+    * returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>array</tt>
+    * is <tt>null</tt>, in which case <tt>"null"</tt> is returned.
+    * <p>
+    * This method is useful to dump the content of the array in a tracing 
+    * method, e.g.:
+    * <pre>
+    * logger.entering(CLASSNAME, "foo(Object[])", ArraysUtil.toString(array));
+    * </pre>
+    * @param array The array whose string representation to return.  
+    * @return A string representation of <tt>array</tt>.
+    */
+   public static String toString (Object array)
+   {
+      final String result;
+      
+      if (array == null)
+      {
+         result = "null";
+      }
+      else if (!array.getClass().isArray())
+      {
+          result = String.valueOf(array);
+      }
+      else if (array instanceof Object[])
+      {
+          result = ArraysUtil.toString((Object[]) array);
+      }
+      else if (array instanceof boolean[])
+      {
+          result = ArraysUtil.toString((boolean[]) array);
+      }
+      else if (array instanceof byte[])
+      {
+          result = ArraysUtil.toString((byte[]) array);
+      }
+      else if (array instanceof short[])
+      {
+          result = ArraysUtil.toString((short[]) array);
+      }
+      else if (array instanceof char[])
+      {
+          result = ArraysUtil.toString((char[]) array);
+      }
+      else if (array instanceof int[])
+      {
+          result = ArraysUtil.toString((int[]) array);
+      }
+      else if (array instanceof long[])
+      {
+          result = ArraysUtil.toString((long[]) array);
+      }
+      else // no float/double
+      {
+          result = String.valueOf(array);
+      }
+      return result;
+   }
+
+
    /**
     * Returns a string representation of the contents of the specified array. 
@@ -96 +167 @@
                buf.append(", ");
             }
-            if (array[i] instanceof Object[]) 
-            {
-               buf.append(ArraysUtil.toString((Object[]) array[i]));
-            }
-            else
-            {
-               buf.append(String.valueOf(array[i]));
-            }
+            buf.append(toString(array[i]));
          }
          buf.append(']');
@@ -110 +174 @@
       return result;
    }
+
+
+   /**
+    * Returns a string representation of the contents of the specified array. 
+    * <p>
+    * The value dumps all int stored in the given array.
+    * <p>
+    * This method is useful to dump the content of the array in a tracing 
+    * method, e.g.:
+    * <pre>
+    * logger.entering(CLASSNAME, "foo(int[])", ArraysUtil.toString(array));
+    * </pre>
+    * @param array The array whose string representation to return.  
+    * @return A string representation of <tt>array</tt>.
+    */
+    public static String toString (int[] array)
+    {
+        final String result;
+        
+        if (array == null)
+        {
+           result = "null";
+        }
+        else if (array.length == 0)
+        {
+           result = "[]";
+        }
+        else
+        {
+           final StringBuffer buf = new StringBuffer();
+           for (int i = 0; i < array.length; i++)
+           {
+              if (i == 0)
+              {
+                 buf.append('[');
+              }
+              else
+              {
+                 buf.append(", ");
+              }
+              buf.append(String.valueOf(array[i]));
+           }
+           buf.append(']');
+           result = buf.toString();
+        }
+        return result;
+    }
+
+    /**
+     * Returns a string representation of the contents of the specified array. 
+     * <p>
+     * The value dumps all short stored in the given array.
+     * <p>
+     * This method is useful to dump the content of the array in a tracing 
+     * method, e.g.:
+     * <pre>
+     * logger.entering(CLASSNAME, "foo(short[])", ArraysUtil.toString(array));
+     * </pre>
+     * @param array The array whose string representation to return.  
+     * @return A string representation of <tt>array</tt>.
+     */
+     public static String toString (short[] array)
+     {
+         final String result;
+         
+         if (array == null)
+         {
+            result = "null";
+         }
+         else if (array.length == 0)
+         {
+            result = "[]";
+         }
+         else
+         {
+            final StringBuffer buf = new StringBuffer();
+            for (int i = 0; i < array.length; i++)
+            {
+               if (i == 0)
+               {
+                  buf.append('[');
+               }
+               else
+               {
+                  buf.append(", ");
+               }
+               buf.append(String.valueOf(array[i]));
+            }
+            buf.append(']');
+            result = buf.toString();
+         }
+         return result;
+     }
+
+     /**
+      * Returns a string representation of the contents of the specified array. 
+      * <p>
+      * The value dumps all long stored in the given array.
+      * <p>
+      * This method is useful to dump the content of the array in a tracing 
+      * method, e.g.:
+      * <pre>
+      * logger.entering(CLASSNAME, "foo(long[])", ArraysUtil.toString(array));
+      * </pre>
+      * @param array The array whose string representation to return.  
+      * @return A string representation of <tt>array</tt>.
+      */
+      public static String toString (long[] array)
+      {
+          final String result;
+          
+          if (array == null)
+          {
+             result = "null";
+          }
+          else if (array.length == 0)
+          {
+             result = "[]";
+          }
+          else
+          {
+             final StringBuffer buf = new StringBuffer();
+             for (int i = 0; i < array.length; i++)
+             {
+                if (i == 0)
+                {
+                   buf.append('[');
+                }
+                else
+                {
+                   buf.append(", ");
+                }
+                buf.append(String.valueOf(array[i]));
+             }
+             buf.append(']');
+             result = buf.toString();
+          }
+          return result;
+      }
+      
+      /**
+       * Returns a string representation of the contents of the specified array. 
+       * <p>
+       * The value dumps all byte values stored in the given array.
+       * <p>
+       * This method is useful to dump the content of the array in a tracing 
+       * method, e.g.:
+       * <pre>
+       * logger.entering(CLASSNAME, "foo(byte[])", ArraysUtil.toString(array));
+       * </pre>
+       * @param array The array whose string representation to return.  
+       * @return A string representation of <tt>array</tt>.
+       */
+       public static String toString (byte[] array)
+       {
+           final String result;
+           
+           if (array == null)
+           {
+              result = "null";
+           }
+           else if (array.length == 0)
+           {
+              result = "[]";
+           }
+           else
+           {
+              final StringBuffer buf = new StringBuffer();
+              for (int i = 0; i < array.length; i++)
+              {
+                 if (i == 0)
+                 {
+                    buf.append('[');
+                 }
+                 else
+                 {
+                    buf.append(", ");
+                 }
+                 buf.append(String.valueOf(array[i]));
+              }
+              buf.append(']');
+              result = buf.toString();
+           }
+           return result;
+       }
+       
+       /**
+        * Returns a string representation of the contents of the specified array. 
+        * <p>
+        * The value dumps all char values stored in the given array.
+        * <p>
+        * This method is useful to dump the content of the array in a tracing 
+        * method, e.g.:
+        * <pre>
+        * logger.entering(CLASSNAME, "foo(char[])", ArraysUtil.toString(array));
+        * </pre>
+        * @param array The array whose string representation to return.  
+        * @return A string representation of <tt>array</tt>.
+        */
+        public static String toString (char[] array)
+        {
+            final String result;
+            
+            if (array == null)
+            {
+               result = "null";
+            }
+            else if (array.length == 0)
+            {
+               result = "[]";
+            }
+            else
+            {
+               final StringBuffer buf = new StringBuffer();
+               for (int i = 0; i < array.length; i++)
+               {
+                  if (i == 0)
+                  {
+                     buf.append('[');
+                  }
+                  else
+                  {
+                     buf.append(", ");
+                  }
+                  buf.append(String.valueOf(array[i]));
+               }
+               buf.append(']');
+               result = buf.toString();
+            }
+            return result;
+        }
+
+        /**
+         * Returns a string representation of the contents of the specified array. 
+         * <p>
+         * The value dumps all boolean values stored in the given array.
+         * <p>
+         * This method is useful to dump the content of the array in a tracing 
+         * method, e.g.:
+         * <pre>
+         * logger.entering(CLASSNAME, "foo(boolean[])", ArraysUtil.toString(array));
+         * </pre>
+         * @param array The array whose string representation to return.  
+         * @return A string representation of <tt>array</tt>.
+         */
+         public static String toString (boolean[] array)
+         {
+             final String result;
+             
+             if (array == null)
+             {
+                result = "null";
+             }
+             else if (array.length == 0)
+             {
+                result = "[]";
+             }
+             else
+             {
+                final StringBuffer buf = new StringBuffer();
+                for (int i = 0; i < array.length; i++)
+                {
+                   if (i == 0)
+                   {
+                      buf.append('[');
+                   }
+                   else
+                   {
+                      buf.append(", ");
+                   }
+                   buf.append(String.valueOf(array[i]));
+                }
+                buf.append(']');
+                result = buf.toString();
+             }
+             return result;
+         }
+         
+         
 }

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

@@ -50 +50 @@
     extends UserTypeBase
 {
+    private static final long serialVersionUID = 1L;
     private static final int SQL_TYPE = Types.NUMERIC;
     private static final int[] SQL_TYPES = {SQL_TYPE};

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

@@ -49 +49 @@
     extends UserTypeBase
 {
+    private static final long serialVersionUID = 1L;
     private static final int SQL_TYPE = Types.INTEGER;
     private static final int[] SQL_TYPES = {SQL_TYPE};

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

@@ -56 +56 @@
  *
  * @author Albrecht Messner
+ * @author Andreas Mandel
  */
 public final class LoggingProxy
@@ -136 +137 @@
          else
          {
+            final Object[] args2 = new Object[args.length];
+            for (int i = 0; i < args.length; i++)
+            {
+                if (args[i] != null && args[i].getClass().isArray())
+                {
+                    args2[i] = ArraysUtil.toString(args[i]);
+                }
+                else
+                {
+                    args2[i] = args[1];
+                }
+            }
             mObjectLogger.entering(
-                  mRealObjectClassName, method.getName(), args);
+                  mRealObjectClassName, method.getName(), args2);
          }
       }
@@ -148 +161 @@
          {
            mObjectLogger.exiting(
-                 mRealObjectClassName, method.getName(), result);
+                 mRealObjectClassName, method.getName(), 
+                 ArraysUtil.toString(result));
          }
          else

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

@@ -50 +50 @@
     extends UserTypeBase
 {
+    private static final long serialVersionUID = 1L;
     private static final int SQL_TYPE = Types.INTEGER;
     private static final int[] SQL_TYPES = {SQL_TYPE};

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

@@ -52 +52 @@
     extends UserTypeBase
 {
+    private static final long serialVersionUID = 1L;
     private static final int SQL_TYPE = Types.VARCHAR;
     private static final int[] SQL_TYPES = {SQL_TYPE};

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

@@ -165 +165 @@
          // supported by the JDK
          throw new RuntimeException(
-               "UTF-8 character encoding not supported?", e);
+               "ASCII character encoding not supported?", e);
       }
       return result;

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

@@ -273 +273 @@
               && methods[i].getDeclaringClass() != Object.class
               && methods[i].getParameterTypes().length == 0
+              && methods[i].getExceptionTypes().length == 0
               && Modifier.isPublic(modifier)
               && !Modifier.isStatic(modifier)

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

@@ -51 +51 @@
 public abstract class UserTypeBase implements UserType, Serializable
 {
+    private static final long serialVersionUID = 1L;
 
     /**