Coverage Report - org.apache.maven.surefire.util.NestedRuntimeException
 
Classes in this File Line Coverage Branch Coverage Complexity
NestedRuntimeException
0%
0/20
0%
0/8
1,833
 
 1  
 package org.apache.maven.surefire.util;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *     http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 /*
 23  
  * Copyright 2002-2005 the original author or authors.
 24  
  *
 25  
  * Licensed under the Apache License, Version 2.0 (the "License");
 26  
  * you may not use this file except in compliance with the License.
 27  
  * You may obtain a copy of the License at
 28  
  *
 29  
  *      http://www.apache.org/licenses/LICENSE-2.0
 30  
  *
 31  
  * Unless required by applicable law or agreed to in writing, software
 32  
  * distributed under the License is distributed on an "AS IS" BASIS,
 33  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 34  
  * See the License for the specific language governing permissions and
 35  
  * limitations under the License.
 36  
  */
 37  
 
 38  
 import java.io.PrintStream;
 39  
 import java.io.PrintWriter;
 40  
 
 41  
 /**
 42  
  * <p>Copied from Spring framework to keep Java 1.3 compatability.</p>
 43  
  * <p/>
 44  
  * <p>Handy class for wrapping runtime Exceptions with a root cause.</p>
 45  
  * <p/>
 46  
  * <p>This time-honoured technique is no longer necessary in Java 1.4, which
 47  
  * finally provides built-in support for exception nesting. Thus exceptions in
 48  
  * applications written to use Java 1.4 need not extend this class. To ease
 49  
  * migration, this class mirrors Java 1.4's nested exceptions as closely as possible.
 50  
  * <p/>
 51  
  * <p>Abstract to force the programmer to extend the class. <code>getMessage</code>
 52  
  * will include nested exception information; <code>printStackTrace</code> etc will
 53  
  * delegate to the wrapped exception, if any.
 54  
  * <p/>
 55  
  * <p>The similarity between this class and the NestedCheckedException class is
 56  
  * unavoidable, as Java forces these two classes to have different superclasses
 57  
  * (ah, the inflexibility of concrete inheritance!).
 58  
  * <p/>
 59  
  * <p>As discussed in
 60  
  * <a href="http://www.amazon.com/exec/obidos/tg/detail/-/0764543857/">Expert One-On-One J2EE Design and
 61  
  * Development</a>, runtime exceptions are often a better alternative to checked exceptions.
 62  
  * However, all exceptions should preserve their stack trace, if caused by a
 63  
  * lower-level exception.
 64  
  *
 65  
  * @author Rod Johnson
 66  
  * @author Juergen Hoeller
 67  
  * @see #getMessage
 68  
  * @see #printStackTrace
 69  
  * @see NestedCheckedException
 70  
  */
 71  
 public class NestedRuntimeException
 72  
     extends RuntimeException
 73  
 {
 74  
 
 75  
     /**
 76  
      * Root cause of this nested exception
 77  
      */
 78  
     private final Throwable cause;
 79  
 
 80  
     /**
 81  
      * Construct a <code>NestedRuntimeException</code> with the specified detail message
 82  
      * and nested exception.
 83  
      *
 84  
      * @param msg the detail message
 85  
      * @param ex  the nested exception
 86  
      */
 87  
     public NestedRuntimeException( String msg, Throwable ex )
 88  
     {
 89  0
         super( msg );
 90  0
         this.cause = ex;
 91  0
     }
 92  
 
 93  
     /**
 94  
      * Construct a <code>NestedRuntimeException</code> with the specified nested exception.
 95  
      *
 96  
      * @param ex the nested exception
 97  
      */
 98  
     public NestedRuntimeException( Throwable ex )
 99  
     {
 100  0
         super();
 101  0
         this.cause = ex;
 102  0
     }
 103  
 
 104  
     /**
 105  
      * Return the nested cause, or <code>null</code> if none.
 106  
      * <p>Note that this will only check one level of nesting.
 107  
      * Use <code>getRootCause()</code> to retrieve the innermost cause.
 108  
      */
 109  
     public Throwable getCause()
 110  
     {
 111  
         // Even if you cannot set the cause of this exception other than through
 112  
         // the constructor, we check for the cause being "this" here, as the cause
 113  
         // could still be set to "this" via reflection: for example, by a remoting
 114  
         // deserializer like Hessian's.
 115  0
         return ( this.cause == this ? null : this.cause );
 116  
     }
 117  
 
 118  
     /**
 119  
      * Return the detail message, including the message from the nested exception
 120  
      * if there is one.
 121  
      */
 122  
     public String getMessage()
 123  
     {
 124  0
         if ( getCause() == null )
 125  
         {
 126  0
             return super.getMessage();
 127  
         }
 128  
         else
 129  
         {
 130  0
             return super.getMessage() + "; nested exception is " + getCause().getClass().getName() + ": "
 131  
                 + getCause().getMessage();
 132  
         }
 133  
     }
 134  
 
 135  
     /**
 136  
      * Print the composite message and the embedded stack trace to the specified stream.
 137  
      *
 138  
      * @param ps the print stream
 139  
      */
 140  
     public void printStackTrace( PrintStream ps )
 141  
     {
 142  0
         if ( getCause() == null )
 143  
         {
 144  0
             super.printStackTrace( ps );
 145  
         }
 146  
         else
 147  
         {
 148  0
             ps.println( this );
 149  0
             getCause().printStackTrace( ps );
 150  
         }
 151  0
     }
 152  
 
 153  
     /**
 154  
      * Print the composite message and the embedded stack trace to the specified writer.
 155  
      *
 156  
      * @param pw the print writer
 157  
      */
 158  
     public void printStackTrace( PrintWriter pw )
 159  
     {
 160  0
         if ( getCause() == null )
 161  
         {
 162  0
             super.printStackTrace( pw );
 163  
         }
 164  
         else
 165  
         {
 166  0
             pw.println( this );
 167  0
             getCause().printStackTrace( pw );
 168  
         }
 169  0
     }
 170  
 }