|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
org.crosswire.common.util.LucidException
public class LucidException
A LucidException adds 2 concepts to a base Exception, that of a wrapped Exception, that of internationalized (i18n) messages.
The first addition is the concept of an optional wrapped Exception (actually a Throwable), which describes what caused this to happen. Any well defined interface will define the exact exceptions that the methods of that interface will throw, and not leave it to the ambiguous "throws Exception". However the interface should have no idea how it will be implemented and so the details of exactly what broke under the covers gets lost. With LucidException this detail is kept in the wrapped Exception. This functionality has been added to the base Exception class in J2SE 1.4
The second addition is the concept of i18n messages. Normal Exceptions are created with an almost random string in the message field, LucidExceptions define this string to be a key into a resource bundle, and to help formatting this string there is an optional Object array of format options. There is a constructor that allows us to specify no i18n lookup, which is useful if this lookup may have been done already.
for license details.
The copyright to this program is held by it's authors.
,
LucidRuntimeException
,
Serialized FormField Summary | |
---|---|
private boolean |
deprecated
Is the message to be included literally (ie passed a string), or should we look it up as a resource (ie passed a MsgBase). |
private static Logger |
log
The log stream |
protected Object[] |
params
The array of parameters |
private static long |
serialVersionUID
Serialization ID |
Constructor Summary | |
---|---|
LucidException(MsgBase msg)
All LucidExceptions are constructed with references to resources in an i18n properties file. |
|
LucidException(MsgBase msg,
Object[] params)
All LucidExceptions are constructed with references to resources in an i18n properties file. |
|
LucidException(MsgBase msg,
Throwable cause)
All LucidExceptions are constructed with references to resources in an i18n properties file. |
|
LucidException(MsgBase msg,
Throwable cause,
Object[] params)
All LucidExceptions are constructed with references to resources in an i18n properties file. |
Method Summary | |
---|---|
String |
getDetailedMessage()
Accessor of the full detailed version of the string |
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 |
---|
private static final Logger log
private static final long serialVersionUID
private final boolean deprecated
protected final Object[] params
Constructor Detail |
---|
public LucidException(MsgBase msg)
msg
- The resource id to readpublic LucidException(MsgBase msg, Throwable cause)
msg
- The resource id to readpublic LucidException(MsgBase msg, Object[] params)
msg
- The resource id to readparams
- An array of parameterspublic LucidException(MsgBase msg, Throwable cause, Object[] params)
msg
- The resource id to readparams
- An array of parametersMethod Detail |
---|
public String getMessage()
getMessage
in class Throwable
public String getDetailedMessage()
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |