org.crosswire.common.util
Class LucidRuntimeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.crosswire.common.util.LucidRuntimeException

All Implemented Interfaces:

Serializable

public class LucidRuntimeException
extends RuntimeException

EventExceptions are generally used for passing problems through the event system which does not allow checked exceptions through.

So LucidRuntimeException is a LucidException in all but inheritance - LucidException inherits from Exception and so is checked, where EventEception inherits from RuntimeException and so is not checked. In general you would create a subclass of LucidException before you used it, however EventExceptions would be used directly.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: LucidRuntimeException.java,v 1.5 2005/01/24 23:22:06 dmsmith Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence, LucidException, Serialized Form

Field Summary

private static Logger	log The log stream
protected Object[]	params The array of parameters
private static long	serialVersionUID Serialization ID

Constructor Summary

LucidRuntimeException(MsgBase msg)
All LucidRuntimeException are constructed with references to resources in an i18n properties file.

LucidRuntimeException(MsgBase msg, Object[] params)
All LucidRuntimeException are constructed with references to resources in an i18n properties file.

LucidRuntimeException(MsgBase msg, Throwable cause)
All LucidRuntimeException are constructed with references to resources in an i18n properties file.

LucidRuntimeException(MsgBase msg, Throwable cause, Object[] params)
All LucidRuntimeException are constructed with references to resources in an i18n properties file.

Method Summary

String

getMessage() We only unravel the message when we need to to save time

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final Logger log

The log stream

serialVersionUID

private static final long serialVersionUID

Serialization ID

See Also:

Constant Field Values

params

protected final Object[] params

The array of parameters

Constructor Detail

LucidRuntimeException

public LucidRuntimeException(MsgBase msg)

All LucidRuntimeException are constructed with references to resources in an i18n properties file.

Parameters:

msg - The resource id to read

LucidRuntimeException

public LucidRuntimeException(MsgBase msg,
                             Throwable cause)

All LucidRuntimeException are constructed with references to resources in an i18n properties file.

Parameters:

msg - The resource id to read

LucidRuntimeException

public LucidRuntimeException(MsgBase msg,
                             Object[] params)

All LucidRuntimeException are constructed with references to resources in an i18n properties file. This version allows us to add parameters

Parameters:

msg - The resource id to read

params - An array of parameters

LucidRuntimeException

public LucidRuntimeException(MsgBase msg,
                             Throwable cause,
                             Object[] params)

All LucidRuntimeException are constructed with references to resources in an i18n properties file. This version allows us to add parameters

Parameters:

msg - The resource id to read

params - An array of parameters

Method Detail

getMessage

public String getMessage()

We only unravel the message when we need to to save time

Overrides:

getMessage in class Throwable

Returns:

The unraveled i18n string