org.apache.commons.mail.EmailException Maven / Gradle / Ivy
Show all versions of commons-email Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.commons.mail;
import java.io.PrintStream;
import java.io.PrintWriter;
/**
* Exception thrown when a checked error occurs in commons-email.
*
* Supports nesting, emulating JDK 1.4 behavior if necessary.
*
* Adapted from FunctorException in Commons Collections.
*
* @author jakarta-commons
* @since 1.0
* @version $Id: EmailException.java 510812 2007-02-23 04:32:22Z dion $
*/
public class EmailException
extends Exception
{
/** Serializable version identifier */
static final long serialVersionUID = 5550674499282474616L;
/**
* Does JDK support nested exceptions?
*/
private static final boolean JDK_SUPPORTS_NESTED;
static
{
boolean flag = false;
try
{
Throwable.class.getDeclaredMethod("getCause", new Class[0]);
flag = true;
}
catch (NoSuchMethodException ex)
{
flag = false;
}
JDK_SUPPORTS_NESTED = flag;
}
/**
* Root cause of the exception
*/
private final Throwable rootCause;
/**
* Constructs a new EmailException
with no
* detail message.
*/
public EmailException()
{
super();
this.rootCause = null;
}
/**
* Constructs a new EmailException
with specified
* detail message.
*
* @param msg the error message.
*/
public EmailException(String msg)
{
super(msg);
this.rootCause = null;
}
/**
* Constructs a new EmailException
with specified
* nested Throwable
root cause.
*
* @param rootCause the exception or error that caused this exception
* to be thrown.
*/
public EmailException(Throwable rootCause)
{
super((rootCause == null) ? null : rootCause.getMessage());
this.rootCause = rootCause;
}
/**
* Constructs a new EmailException
with specified
* detail message and nested Throwable
root cause.
*
* @param msg the error message.
* @param rootCause the exception or error that caused this exception
* to be thrown.
*/
public EmailException(String msg, Throwable rootCause)
{
super(msg);
this.rootCause = rootCause;
}
/**
* Gets the cause of this throwable.
*
* @return the cause of this throwable, or null
*/
public Throwable getCause()
{
return rootCause;
}
/**
* Prints the stack trace of this exception to the standard error stream.
*/
public void printStackTrace()
{
printStackTrace(System.err);
}
/**
* Prints the stack trace of this exception to the specified stream.
*
* @param out the PrintStream
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 GC'ed.
pw.flush();
}
}
/**
* Prints the stack trace of this exception to the specified writer.
*
* @param out the PrintWriter
to use for output
*/
public void printStackTrace(PrintWriter out)
{
synchronized (out)
{
super.printStackTrace(out);
if (!JDK_SUPPORTS_NESTED && (rootCause != null))
{
out.print("Caused by: ");
rootCause.printStackTrace(out);
}
}
}
}