001: /*
002: * @(#)ProblemManagerException.java
003: *
004: * Copyright (C) 2002-2003 Matt Albrecht
005: * groboclown@users.sourceforge.net
006: * http://groboutils.sourceforge.net
007: *
008: * Part of the GroboUtils package at:
009: * http://groboutils.sourceforge.net
010: *
011: * Permission is hereby granted, free of charge, to any person obtaining a
012: * copy of this software and associated documentation files (the "Software"),
013: * to deal in the Software without restriction, including without limitation
014: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
015: * and/or sell copies of the Software, and to permit persons to whom the
016: * Software is furnished to do so, subject to the following conditions:
017: *
018: * The above copyright notice and this permission notice shall be included in
019: * all copies or substantial portions of the Software.
020: *
021: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
022: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
023: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
024: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
025: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
026: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
027: * DEALINGS IN THE SOFTWARE.
028: */
029: package net.sourceforge.groboutils.pmti.v1;
030:
031: import net.sourceforge.groboutils.util.throwable.v1.IChainableException;
032: import net.sourceforge.groboutils.util.throwable.v1.ChainableExceptionHelper;
033:
034: import java.io.IOException;
035: import java.io.PrintStream;
036: import java.io.PrintWriter;
037:
038: /**
039: * General exception thrown by the Problem Manager if an unexpected
040: * circumstance occurs.
041: *
042: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
043: * @version $Date: 2003/02/10 22:51:55 $
044: * @since July 7, 2002
045: */
046: public class ProblemManagerException extends IOException implements
047: IChainableException {
048: /**
049: * @serial
050: */
051: private ChainableExceptionHelper ceh;
052:
053: public ProblemManagerException() {
054: super ();
055: this .ceh = new ChainableExceptionHelper(this );
056: }
057:
058: public ProblemManagerException(String message) {
059: super (message);
060: this .ceh = new ChainableExceptionHelper(this );
061: }
062:
063: public ProblemManagerException(Throwable cause) {
064: super ();
065: this .ceh = new ChainableExceptionHelper(this , cause);
066: }
067:
068: public ProblemManagerException(Throwable cause, String message) {
069: this (message, cause);
070: }
071:
072: public ProblemManagerException(String message, Throwable cause) {
073: super (message);
074: this .ceh = new ChainableExceptionHelper(this , cause);
075: }
076:
077: /**
078: * JDK 1.4 compatible method.
079: * <P>
080: * <i>from the JDK 1.4 documentation:</i>
081: * <BLOCKQUOTE>
082: * Returns the cause of this throwable or <tt>null</tt> if the cause is
083: * nonexistent or unknown. (The cause is the throwable that caused this
084: * throwable to get thrown.)
085: * <P>
086: * This implementation returns the cause that was supplied via one of the
087: * constructors requiring a <tt>Throwable</tt>, or that was set after
088: * creation with the <tt>initCause( Throwable )</tt> method. While it is
089: * typically unnecessary to override this method, a subclass can override
090: * it to return a cause set by some other means. This is appropriate for a
091: * "legacy chained throwable" that predates the addition of chained
092: * exceptions to <tt>Throwable</tt>. Note that it is not necessary to
093: * override any of the <tt>PrintStackTrace</tt> methods, all of which
094: * invoke the getCause method to determine the cause of a throwable.
095: * </BLOCKQUOTE>
096: *
097: * @return the cause of this throwable or <tt>null</tt> if the cause is
098: * nonexistent or unknown.
099: */
100: public Throwable getCause() {
101: return this .ceh.getCause();
102: }
103:
104: /**
105: * JDK 1.4 compatible method.
106: * <P>
107: * <i>from the JDK 1.4 documentation:</i>
108: * <BLOCKQUOTE>
109: * Initializes the cause of this throwable to the specified value.
110: * (The cause is the throwable that caused this throwable to get thrown.)
111: * <P>
112: * This method can be called at most once. It is generally called from
113: * within the constructor, or immediately after creating the throwable.
114: * If this throwable was created with Throwable(Throwable) or
115: * Throwable(String,Throwable), this method cannot be called even once.
116: * </BLOCKQUOTE>
117: *
118: * @param cause the cause (which is saved for later retrieval by the
119: * getCause() method). (A null value is permitted, and indicates
120: * that the cause is nonexistent or unknown.)
121: * @return a reference to this Throwable instance.
122: * @exception IllegalArgumentException if cause is this throwable.
123: * (A throwable cannot be its own cause.)
124: * @exception IllegalStateException if this throwable was created with
125: * Throwable(Throwable) or Throwable(String,Throwable), or this
126: * method has already been called on this throwable.
127: */
128: public synchronized Throwable initCause(Throwable cause) {
129: return this .ceh.initCause(cause);
130: }
131:
132: /**
133: * For non-JDK 1.4 compatible VMs, this overrides the original behavior
134: * to describe the underlying cause. Special logic is performed to ensure
135: * that no JDK 1.4 VM is being used when the inner exception is displayed
136: * (in order to prevent double printing).
137: */
138: public void printStackTrace(PrintStream ps) {
139: this .ceh.printStackTrace(ps);
140: }
141:
142: /**
143: * For non-JDK 1.4 compatible VMs, this overrides the original behavior
144: * to describe the underlying cause. Special logic is performed to ensure
145: * that no JDK 1.4 VM is being used when the inner exception is displayed
146: * (in order to prevent double printing).
147: */
148: public void printStackTrace(PrintWriter pw) {
149: this.ceh.printStackTrace(pw);
150: }
151: }
|