org.jboss.util.NestedException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-common-core Show documentation
JBoss Common Core Utility classes
The newest version!
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2015, Red Hat, Inc., and individual contributors as indicated
 * by the @authors tag.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.util;

import java.io.PrintWriter;
import java.io.PrintStream;

/**
 * A common superclass for Exception classes that can contain
 * a nested Throwable detail object.
 *
 * @version $Revision$
 * @author  Jason Dillon
 */
public class NestedException
   extends Exception
   implements NestedThrowable
{
   /** The serialVersionUID */
   private static final long serialVersionUID = 7003381223684751953L;
   /** The nested throwable */
   protected final Throwable nested;

   /**
    * Construct a NestedException with the specified detail 
    * message.
    *
    * @param msg  Detail message.
    */
   public NestedException(final String msg) {
      super(msg);
      this.nested = null;
   }

   /**
    * Construct a NestedException with the specified detail 
    * message and nested Throwable.
    *
    * @param msg     Detail message.
    * @param nested  Nested Throwable.
    */
   public NestedException(final String msg, final Throwable nested) {
      super(msg);
      this.nested = nested;
      NestedThrowable.Util.checkNested(this, nested);
   }

   /**
    * Construct a NestedException with the specified
    * nested Throwable.
    *
    * @param nested  Nested Throwable.
    */
   public NestedException(final Throwable nested) {
      this(nested.getMessage(), nested);
   }

   /**
    * Construct a NestedException with no detail.
    */
   public NestedException() {
      super();
      this.nested = null;
   }
   
   /**
    * Return the nested Throwable.
    *
    * @return  Nested Throwable.
    */
   public Throwable getNested() {
      return nested;
   }

   /**
    * Return the nested Throwable.
    *
    * For JDK 1.4 compatibility.
    *
    * @return  Nested Throwable.
    */
   public Throwable getCause() {
      return nested;
   }
      
   /**
    * Returns the composite throwable message.
    *
    * @return  The composite throwable message.
    */
   public String getMessage() {
      return NestedThrowable.Util.getMessage(super.getMessage(), nested);
   }

   /**
    * Prints the composite message and the embedded stack trace to the
    * specified print stream.
    *
    * @param stream  Stream to print to.
    */
   public void printStackTrace(final PrintStream stream) {
      if (nested == null || NestedThrowable.PARENT_TRACE_ENABLED) {
         super.printStackTrace(stream);
      }
      NestedThrowable.Util.print(nested, stream);
   }

   /**
    * Prints the composite message and the embedded stack trace to the
    * specified print writer.
    *
    * @param writer  Writer to print to.
    */
   public void printStackTrace(final PrintWriter writer) {
      if (nested == null || NestedThrowable.PARENT_TRACE_ENABLED) {
         super.printStackTrace(writer);
      }
      NestedThrowable.Util.print(nested, writer);
   }

   /**
    * Prints the composite message and the embedded stack trace to 
    * System.err.
    */
   public void printStackTrace() {
      printStackTrace(System.err);
   }
}