001: /*
002: * @(#)IChainableException.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.util.throwable.v1;
030:
031: import java.io.PrintStream;
032: import java.io.PrintWriter;
033:
034: /**
035: * Marker interface to tell the <tt>ChainableExceptionHelper</tt> not to use
036: * this class's getCause method.
037: *
038: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
039: * @version $Date: 2003/02/10 22:52:38 $
040: * @since July 7, 2002
041: */
042: public interface IChainableException {
043: // list all methods that must be re-implemented in the exception.
044:
045: /**
046: * JDK 1.4 compatible method.
047: * <P>
048: * <i>from the JDK 1.4 documentation:</i>
049: * <BLOCKQUOTE>
050: * Returns the cause of this throwable or <tt>null</tt> if the cause is
051: * nonexistent or unknown. (The cause is the throwable that caused this
052: * throwable to get thrown.)
053: * <P>
054: * This implementation returns the cause that was supplied via one of the
055: * constructors requiring a <tt>Throwable</tt>, or that was set after
056: * creation with the <tt>initCause( Throwable )</tt> method. While it is
057: * typically unnecessary to override this method, a subclass can override
058: * it to return a cause set by some other means. This is appropriate for a
059: * "legacy chained throwable" that predates the addition of chained
060: * exceptions to <tt>Throwable</tt>. Note that it is not necessary to
061: * override any of the <tt>PrintStackTrace</tt> methods, all of which
062: * invoke the getCause method to determine the cause of a throwable.
063: * </BLOCKQUOTE>
064: *
065: * @return the cause of this throwable or <tt>null</tt> if the cause is
066: * nonexistent or unknown.
067: */
068: public Throwable getCause();
069:
070: /**
071: * JDK 1.4 compatible method.
072: * <P>
073: * <i>from the JDK 1.4 documentation:</i>
074: * <BLOCKQUOTE>
075: * Initializes the cause of this throwable to the specified value.
076: * (The cause is the throwable that caused this throwable to get thrown.)
077: * <P>
078: * This method can be called at most once. It is generally called from
079: * within the constructor, or immediately after creating the throwable.
080: * If this throwable was created with Throwable(Throwable) or
081: * Throwable(String,Throwable), this method cannot be called even once.
082: * </BLOCKQUOTE>
083: *
084: * @param cause the cause (which is saved for later retrieval by the
085: * getCause() method). (A null value is permitted, and indicates
086: * that the cause is nonexistent or unknown.)
087: * @return a reference to this Throwable instance.
088: * @exception IllegalArgumentException if cause is this throwable.
089: * (A throwable cannot be its own cause.)
090: * @exception IllegalStateException if this throwable was created with
091: * Throwable(Throwable) or Throwable(String,Throwable), or this
092: * method has already been called on this throwable.
093: */
094: public Throwable initCause(Throwable cause);
095:
096: /**
097: * For non-JDK 1.4 compatible VMs, this overrides the original behavior
098: * to describe the underlying cause. Special logic is performed to ensure
099: * that no JDK 1.4 VM is being used when the inner exception is displayed
100: * (in order to prevent double printing).
101: */
102: public void printStackTrace(PrintStream ps);
103:
104: /**
105: * For non-JDK 1.4 compatible VMs, this overrides the original behavior
106: * to describe the underlying cause. Special logic is performed to ensure
107: * that no JDK 1.4 VM is being used when the inner exception is displayed
108: * (in order to prevent double printing).
109: */
110: public void printStackTrace(PrintWriter pw);
111: }
|