avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From blorit...@apache.org
Subject cvs commit: jakarta-avalon-logkit/src/compat/org/apache/log/format ExceptionUtil.java
Date Mon, 03 Feb 2003 17:40:54 GMT
bloritsch    2003/02/03 09:40:54

  Added:       src/compat/org/apache/log/format ExceptionUtil.java
  Log:
  add file to make the compatibility without circular dependencies
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-logkit/src/compat/org/apache/log/format/ExceptionUtil.java
  
  Index: ExceptionUtil.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1997-2002 The Apache Software Foundation. All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *    "This product includes software developed by the
   *    Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software
   *    itself, if and wherever such third-party acknowledgments
   *    normally appear.
   *
   * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
   *    must not be used to endorse or promote products derived from this
   *    software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    nor may "Apache" appear in their name, without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation. For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.log.format;
  
  import java.io.PrintWriter;
  import java.io.StringWriter;
  import java.lang.reflect.Method;
  import java.util.StringTokenizer;
  
  /**
   * This class provides basic facilities for manipulating exceptions.
   *
   * Some exception handling stuff thieved from Turbine...
   *
   * @deprecated use org.apache.avalon.framework.ExceptionUtil instead
   *
   * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
   * @version 1.0
   */
  public final class ExceptionUtil
  {
      private static final String LINE_SEPARATOR = System.getProperty( "line.separator" );
      private static final String GET_CAUSE_NAME = "getCause";
      private static final Class[] GET_CAUSE_PARAMTYPES = new Class[ 0 ];
      private static final Class CASCADING_INTERFACE;
  
      static
      {
          Class klass = null;
          try
          {
              klass = Class.forName("org.apache.avalon.framework.CascadingThrowable");
          }
          catch (Exception e)
          {
              // class not available
              klass = null;
          }
  
          CASCADING_INTERFACE = klass;
      }
  
      /**
       * Private constructor to prevent instantiation.
       */
      private ExceptionUtil()
      {
      }
  
      /**
       * Generate string for specified exception and the cause of
       * this exception (if any).
       * @param throwable a <code>Throwable</code>
       * @return the stack trace as a <code>String</code>
       */
      public static String printStackTrace( final Throwable throwable )
      {
          return printStackTrace( throwable, 0, true );
      }
  
      /**
       * Generate string for specified exception and if printCascading
       * is true will print all cascading exceptions.
       * @param throwable a <code>Throwable</code>
       * @param printCascading if <code>true</code> will print all cascading exceptions
       * @return the stack trace as a <code>String</code>
       */
      public static String printStackTrace( final Throwable throwable,
                                            final boolean printCascading )
      {
          return printStackTrace( throwable, 0, printCascading );
      }
  
      /**
       * Serialize the specified <code>Throwable</code> to a string.
       * Restrict the number of frames printed out to the specified depth.
       * If the depth specified is <code>0</code> then all the frames are
       * converted into a string.
       * @param throwable a <code>Throwable</code>
       * @param depth number of stack trace frames to show
       * @return the stack trace as a <code>String</code>
       */
      public static String printStackTrace( final Throwable throwable, final int depth )
      {
          int dp = depth;
          final String[] lines = captureStackTrace( throwable );
  
          if( 0 == dp || dp > lines.length )
          {
              dp = lines.length;
          }
  
          final StringBuffer sb = new StringBuffer();
  
          for( int i = 0; i < dp; i++ )
          {
              sb.append( lines[ i ] );
              sb.append( LINE_SEPARATOR );
          }
  
          return sb.toString();
      }
  
      /**
       * Generate exception string for specified exception to specified depth
       * and all Cascading exceptions if printCascading is true.
       * @param throwable a <code>Throwable</code>
       * @param depth number of stack trace frames to show
       * @param printCascading if <code>true</code> will print all cascading exceptions
       * @return the stack trace as a <code>String</code>
       */
      public static String printStackTrace( final Throwable throwable,
                                            final int depth,
                                            final boolean printCascading )
      {
          return printStackTrace( throwable, depth, printCascading, true );
      }
  
      /**
       * Generate exception string for specified exception to specified depth
       * and all Cascading exceptions if printCascading is true. If useReflection
       * is true then the method will also attempt to use reflection to find a
       * method with signature <code>Throwable getCause()</code>. This makes
       * it compatible with JDK1.4 mechanisms for nesting exceptions.
       * @param throwable a <code>Throwable</code>
       * @param depth number of stack trace frames to show
       * @param printCascading if <code>true</code> will print all cascading exceptions
       * @param useReflection if <code>true</code> will use reflection to handle
JDK1.4
       *                      nested exceptions
       * @return the stack trace as a <code>String</code>
       */
      public static String printStackTrace( final Throwable throwable,
                                            final int depth,
                                            final boolean printCascading,
                                            final boolean useReflection )
      {
          final String result = printStackTrace( throwable, depth );
  
          if( !printCascading )
          {
              return result;
          }
          else
          {
              final StringBuffer sb = new StringBuffer();
              sb.append( result );
  
              Throwable cause = getCause( throwable, useReflection );
  
              while( null != cause )
              {
                  sb.append( "rethrown from" );
                  sb.append( LINE_SEPARATOR );
                  sb.append( printStackTrace( cause, depth ) );
  
                  cause = getCause( cause, useReflection );
              }
  
              return sb.toString();
          }
      }
  
      /**
       * Utility method to get cause of exception.
       * @param throwable a <code>Throwable</code>
       * @param useReflection if <code>true</code> will use reflection to handle
JDK1.4
       *                      nested exceptions
       * @return cause of specified exception
       */
      public static Throwable getCause( final Throwable throwable,
                                        final boolean useReflection )
      {
          if( useReflection ||
              ( null != CASCADING_INTERFACE &&
                  CASCADING_INTERFACE.isAssignableFrom(throwable.getClass()) ) )
          {
              try
              {
                  final Class clazz = throwable.getClass();
                  final Method method =
                      clazz.getMethod( GET_CAUSE_NAME, GET_CAUSE_PARAMTYPES );
                  return (Throwable)method.invoke( throwable, null );
              }
              catch( final Throwable t )
              {
                  return null;
              }
          }
          else
          {
              return null;
          }
      }
  
      /**
       * Captures the stack trace associated with this exception.
       *
       * @param throwable a <code>Throwable</code>
       * @return an array of Strings describing stack frames.
       */
      public static String[] captureStackTrace( final Throwable throwable )
      {
          final StringWriter sw = new StringWriter();
          throwable.printStackTrace( new PrintWriter( sw, true ) );
          return splitStringInternal( sw.toString(), LINE_SEPARATOR );
      }
  
      /**
       * Splits the string on every token into an array of stack frames.
       *
       * @param string the string to split
       * @param onToken the token to split on
       * @return the resultant array
       * @deprecated This is an internal utility method that should not be used
       */
      public static String[] splitString( final String string, final String onToken )
      {
          return splitStringInternal( string, onToken );
      }
  
      /**
       * Splits the string on every token into an array of stack frames.
       *
       * @param string the string to split
       * @param onToken the token to split on
       * @return the resultant array
       */
      private static String[] splitStringInternal( final String string, final String onToken
)
      {
          final StringTokenizer tokenizer = new StringTokenizer( string, onToken );
          final String[] result = new String[ tokenizer.countTokens() ];
  
          for( int i = 0; i < result.length; i++ )
          {
              result[ i ] = tokenizer.nextToken();
          }
  
          return result;
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: avalon-cvs-unsubscribe@jakarta.apache.org
For additional commands, e-mail: avalon-cvs-help@jakarta.apache.org


Mime
View raw message