de.susebox.java.io

Class ExtIOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

de.susebox.java.io.ExtIOException

All Implemented Interfaces:

ThrowableList, java.io.Serializable

public class ExtIOException
extends java.io.IOException
implements ThrowableList

Implementation of the ThrowableList interface for the JDK exception IOException.

Version:

1.00, 2001/06/26

Author:

Heiko Blau

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExtIOException(java.lang.String fmt, java.lang.Object[] args) This constructor takes a format string and its arguments.
ExtIOException(java.lang.Throwable ex) This constructor should be used for wrapping another exception.
ExtIOException(java.lang.Throwable ex, java.lang.String msg) If one likes to add ones own information to an exception, this constructor is the easiest way to do so.
ExtIOException(java.lang.Throwable ex, java.lang.String fmt, java.lang.Object[] args) This is the most complex way to construct an ThrowableList- Throwable. An inner exception is accompanied by a format string and its arguments.

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getArguments() Retrieving the arguments for message formats.
java.lang.Throwable	getCause() Retrieving the cause of a Throwable.
java.lang.String	getFormat() Getting the format string of a throwable message.
java.lang.String	getMessage() Implementation of the standard Throwable.getMessage() method.
boolean	isWrapper() Check if this is only a throwable that wraps the real one.
java.lang.Throwable	nextThrowable() Deprecated. use the JDK 1.4 call getCause() instead

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtIOException

public ExtIOException(java.lang.Throwable ex)

This constructor should be used for wrapping another exception. While reading data an IOException may occur, but a certain interface requires a java.sql.SQLException. Simply use:

 try {
   ...
 } catch (SQLException ex) {
   throw new ExtIOException(ex);
 }

Parameters:

ex - the exception to wrap

ExtIOException

public ExtIOException(java.lang.Throwable ex,
                      java.lang.String msg)

If one likes to add ones own information to an exception, this constructor is the easiest way to do so. By using such an approach a exception trace with useful additional informations (which file could be found, what username is unknown) can be realized:

 try {
   ...
 } catch (SQLException ex) {
   throw new ExtIOException(ex, "while connecting to " + url);
 }

Parameters:

ex - the inner exception

msg - exception message

ExtIOException

public ExtIOException(java.lang.String fmt,
                      java.lang.Object[] args)

This constructor takes a format string and its arguments. The format string must have a form that can be used by MessageFormat methods. That means:

    java.text.Message.format(fmt, args)

is similar to

    new MyException(fmt, args).getMessage();

Parameters:

fmt - exception message

args - arguments for the given format string

ExtIOException

public ExtIOException(java.lang.Throwable ex,
                      java.lang.String fmt,
                      java.lang.Object[] args)

This is the most complex way to construct an ThrowableList- Throwable.
An inner exception is accompanied by a format string and its arguments. Use this constructor in language-sensitive contexts or for formalized messages. The meaning of the parameters is explained in the other constructors.

Parameters:

ex - the inner exception

fmt - exception message

args - arguments for the given format string

Method Detail

getCause

public java.lang.Throwable getCause()

Retrieving the cause of a Throwable. This is the method introduced with JDK 1.4. It replaces the older nextThrowable().

Specified by:

getCause in interface ThrowableList

Overrides:

getCause in class java.lang.Throwable

Returns:

the cause of this Throwable

See Also:

Throwable.getCause()

nextThrowable

public java.lang.Throwable nextThrowable()

Deprecated. use the JDK 1.4 call getCause() instead

Method to traverse the list of Throwable. See ThrowableList.nextThrowable() for details.

Specified by:

nextThrowable in interface ThrowableList

Returns:

the "earlier" throwable

isWrapper

public boolean isWrapper()

Check if this is only a throwable that wraps the real one. See ThrowableList.isWrapper() for details.

Specified by:

isWrapper in interface ThrowableList

Returns:

true if this is a wrapper throwable, false otherwise

getFormat

public java.lang.String getFormat()

Getting the format string of a throwable message. This can also be the message itself if there are no arguments.

Specified by:

getFormat in interface ThrowableList

Returns:

the format string being used by MessageFormat

See Also:

getArguments()

getArguments

public java.lang.Object[] getArguments()

Retrieving the arguments for message formats. These arguments are used by the MessageFormat.format(java.lang.Object[], java.lang.StringBuffer, java.text.FieldPosition) call.

Specified by:

getArguments in interface ThrowableList

Returns:

the arguments for a message format

See Also:

getFormat()

getMessage

public java.lang.String getMessage()

Implementation of the standard Throwable.getMessage() method. It delegates the call to the central ThrowableMessageFormatter.getMessage(de.susebox.java.lang.ThrowableList) method.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the formatted exception message

See Also:

ThrowableMessageFormatter