de.susebox.java.lang

Class ExtIndexOutOfBoundsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IndexOutOfBoundsException

de.susebox.java.lang.ExtIndexOutOfBoundsException

All Implemented Interfaces:

ThrowableList, java.io.Serializable

public class ExtIndexOutOfBoundsException
extends java.lang.IndexOutOfBoundsException
implements ThrowableList

Implementation of the ThrowableList interface for the JDK IndexOutOfBoundsException.

Version:

1.00, 2001/06/26

Author:

Heiko Blau

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExtIndexOutOfBoundsException(java.lang.String msg) This constructor takes a simple message string like ordinary Java Throwable classes.
ExtIndexOutOfBoundsException(java.lang.String fmt, java.lang.Object[] args) This constructor takes a format string and its arguments.
ExtIndexOutOfBoundsException(java.lang.Throwable ex) This constructor should be used for wrapping another throwable.
ExtIndexOutOfBoundsException(java.lang.Throwable ex, java.lang.String msg) If one likes to add ones own information to a throwable, this constructor is the easiest way to do so.
ExtIndexOutOfBoundsException(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 throwable 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

ExtIndexOutOfBoundsException

public ExtIndexOutOfBoundsException(java.lang.String msg)

This constructor takes a simple message string like ordinary Java Throwable classes. This is the most convenient form to construct an ThrowableList throwable.

Parameters:

msg - message for this Throwable instance

ExtIndexOutOfBoundsException

public ExtIndexOutOfBoundsException(java.lang.Throwable ex)

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

 try {
   ...
 } catch (NullPointerException ex) {
   throw new ExtIndexOutOfBoundsException(ex);
 }

Parameters:

ex - the throwable to wrap

ExtIndexOutOfBoundsException

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

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

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

Parameters:

ex - the inner throwable

msg - throwable message

ExtIndexOutOfBoundsException

public ExtIndexOutOfBoundsException(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 - throwable message

args - arguments for the given format string

ExtIndexOutOfBoundsException

public ExtIndexOutOfBoundsException(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 throwable 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 throwable

fmt - throwable 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 throwable message

See Also:

ThrowableMessageFormatter