org.jboss.util.NestedRuntimeException Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.util;
import java.io.PrintWriter;
import java.io.PrintStream;
/**
* A common superclass for RuntimeException classes that can
* contain a nested Throwable detail object.
*
* @version $Revision: 2800 $
* @author Jason Dillon
*/
public class NestedRuntimeException
extends RuntimeException
implements NestedThrowable
{
/** The serialVersionUID */
private static final long serialVersionUID = 9017248167673450852L;
/** The nested throwable */
protected final Throwable nested;
/**
* Construct a NestedRuntimeException with the specified
* detail message.
*
* @param msg Detail message.
*/
public NestedRuntimeException(final String msg) {
super(msg);
this.nested = null;
}
/**
* Construct a NestedRuntimeException with the specified
* detail message and nested Throwable.
*
* @param msg Detail message.
* @param nested Nested Throwable.
*/
public NestedRuntimeException(final String msg, final Throwable nested) {
super(msg);
this.nested = nested;
NestedThrowable.Util.checkNested(this, nested);
}
/**
* Construct a NestedRuntimeException with the specified
* nested Throwable.
*
* @param nested Nested Throwable.
*/
public NestedRuntimeException(final Throwable nested) {
this(nested.getMessage(), nested);
}
/**
* Construct a NestedRuntimeException with no detail.
*/
public NestedRuntimeException() {
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);
}
}