You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jv...@apache.org on 2001/07/31 01:02:33 UTC

cvs commit: jakarta-turbine/src/java/org/apache/turbine/services ServiceRuntimeException.java

jvanzyl     01/07/30 16:02:33

  Added:       src/java/org/apache/turbine/services
                        ServiceRuntimeException.java
  Log:
  - forgot to add this, thanks for catching this kurt.
  
  Revision  Changes    Path
  1.1                  jakarta-turbine/src/java/org/apache/turbine/services/ServiceRuntimeException.java
  
  Index: ServiceRuntimeException.java
  ===================================================================
  package org.apache.turbine.services;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2001 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 "Apache" and "Apache Software Foundation" and 
   *    "Apache Turbine" 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",
   *    "Apache Turbine", 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/>.
   */
  
  import java.io.OutputStream;
  import java.io.PrintStream;
  import java.io.PrintWriter;
  import java.io.StringWriter;
  import java.io.Writer;
  import java.util.LinkedList;
  import java.util.StringTokenizer;
  
  /**
   * This is a base class of runtime exeptions thrown by Turbine.
   *
   * This class represents a non-checked type exception (see 
   * {@see java.lang.RuntimeException}). It has the nested stack trace
   * functionality found in the {@see ServiceException} class.
   * 
   * It's sad that this class is a straight copy/paste of Turbine exception. 
   * I wish that Java supported NonCheckedException marker interface...
   * 
   * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
   */
  public class ServiceRuntimeException 
      extends RuntimeException
  {
      /** 
       * Holds the reference to the exception or error that caused
       * this exception to be thrown.
       */
      private Throwable nested = null;
   
      /**
       * Constructs a new <code>ServiceRuntimeException</code> without specified 
       * detail message.
       */
      public ServiceRuntimeException()
      {
          super();
      }
  
      /**
       * Constructs a new <code>ServiceRuntimeException</code> with specified 
       * detail message.
       *
       * @param msg the error message.
       */
      public ServiceRuntimeException(String msg)
      {
          super(msg);
      }
   
      /**
       * Constructs a new <code>ServiceRuntimeException</code> with specified 
       * nested <code>Throwable</code>.
       *
       * @param nested the exception or error that caused this exception 
       *               to be thrown.
       */
      public ServiceRuntimeException(Throwable nested)
      {
          super();
          this.nested = nested;
      }
   
      /**
       * Constructs a new <code>ServiceRuntimeException</code> with specified 
       * detail message and nested <code>Throwable</code>.
       *
       * @param msg the error message.
       * @param nested the exception or error that caused this exception 
       *               to be thrown.
       */
      public ServiceRuntimeException(String msg, Throwable nested)
      {
          super(msg);
          this.nested = nested;
      }
   
      /**
       * Prints the stack trace of this exception the the standar error 
       * stream.
       */
      public void printStackTrace()
      {
          synchronized(System.err) 
          {
              printStackTrace(System.err);
          }
      }
   
      /**
       * Prints the stack trace of this exception to the specified print stream.
       *
       * @param out <code>PrintStream</code> to use for output
       */
      public void printStackTrace(PrintStream out) 
      {
          synchronized(out) 
          {
              PrintWriter pw=new PrintWriter(out, false);
              printStackTrace(pw);
              // flush the PrintWriter before it's GCed
              pw.flush();
          }
      }
   
      /**
       * Prints the stack trace of this exception to the specified print writer.
       *
       * @param out <code>PrintWriter</code> to use for output.
       */
      public void printStackTrace(PrintWriter out)
      {
          synchronized(out) 
          {
              printStackTrace(out, 0);
          }
      }
   
      /**
       * Prints the stack trace of this exception skiping a specified number
       * of stack frames.
       *
       * @param out <code>PrintWriter</code> to use for output.
       * @param skip the numbere of stack frames to skip.
       */
      public void printStackTrace(PrintWriter out, int skip)
      {
          String[] st = captureStackTrace();
          if(nested != null) 
          {
              if(nested instanceof ServiceRuntimeException) 
              {
                  ((ServiceRuntimeException)nested).printStackTrace(out, st.length - 2);
              } 
              else if(nested instanceof ServiceException) 
              {
                  ((ServiceException)nested).printStackTrace(out, st.length - 2);
              } 
              else 
              {
                  String[] nst = captureStackTrace(nested);
                  for(int i = 0; i<nst.length - st.length + 2; i++) 
                  {
                      out.println(nst[i]);
                  }
              }
              out.print("rethrown as ");
          }
          for(int i=0; i<st.length - skip; i++) 
          {
              out.println(st[i]);
          }
      }
  
      /**
       * Captures the stack trace associated with this exception.
       *
       * @return an array of Strings describing stack frames.
       */ 
      private String[] captureStackTrace() 
      {
          StringWriter sw = new StringWriter();
          super.printStackTrace(new PrintWriter(sw, true));
          return splitStackTrace(sw.getBuffer().toString());
      }
   
      /**
       * Captures the stack trace associated with a <code>Throwable</code> 
       * object.
       *
       * @param t the <code>Throwable</code>.
       * @return an array of Strings describing stack frames.
       */
      private String[] captureStackTrace(Throwable t) 
      {
          StringWriter sw = new StringWriter();
          t.printStackTrace(new PrintWriter(sw, true));
          return splitStackTrace(sw.getBuffer().toString());
      }
    
      /**
       * Splits the stack trace given as a newline separated string
       * into an array of stack frames.
       * 
       * @param stackTrace the stack trace.
       * @return an array of Strings describing stack frames.
       */
      private String[] splitStackTrace(String stackTrace) 
      {
          String linebreak = System.getProperty("line.separator");
          StringTokenizer st = new StringTokenizer(stackTrace, linebreak);
          LinkedList list = new LinkedList();
          while(st.hasMoreTokens()) 
          {
              list.add(st.nextToken());
          }
          return (String [])list.toArray(new String[] {});
      }
  }
  
  
  

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