|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.novell.nds.dirxml.driver.xds.util.DriverException
A useful exception wrapper intended to reduce the complexity of try/catch blocks as well as provide additional context information for exceptions to assist in debugging efforts.
Field Summary | |
static int |
CAT_AUTH
|
static int |
CAT_CONNECT
|
static int |
CAT_ERROR
|
static int |
CAT_FATAL
|
static int |
CAT_RETRY
|
Constructor Summary | |
DriverException(String someMessage)
Creates a new DriverException object. |
Method Summary | |
void |
addThrowables(List someThrowables)
Adds a list of Throwable objects to this exception. |
void |
addThrowble(Throwable someThrowable)
Adds a single Throwable object to this exception. |
void |
appendPostMessage(String someMessage)
Appends a message after the current message. |
void |
appendPreMessage(String someMessage)
Appends a message before the current message. |
boolean |
getAppendDocument()
Should the document that caused this exception be output? |
com.novell.nds.dirxml.driver.XmlDocument |
getDocument()
Returns the XML document associated with this exception. |
String |
getEventID()
Returns the event ID associated with this exception. |
StatusLevel |
getLevel()
Returns the status level of this exception. |
String |
getMessage()
Returns this exception's message. |
boolean |
getPrintStackTrace()
Should the stack trace of each contained Throwable
be output? |
List |
getThrowables()
Returns the List of Throwables contained
by this exception. |
StatusType |
getType()
Returns the status type of this exception. |
boolean |
isAuthenticationRelated()
Does this exception represent an authentication-related error condition? |
boolean |
isConnectivityRelated()
Does this exception represent a connectivity-related error condition? |
boolean |
isFatal()
Does this exception represent a fatal error condition? |
boolean |
isRetry()
Does this exception represent a connectivity-related error condition? |
boolean |
isSpecialCondition()
Does this exception require special handling? |
void |
setAppendDocument(boolean value)
Sets whether the document associated with this exception should be output? |
void |
setCategory(int someCategory)
Sets the category of this exception. |
void |
setDocument(com.novell.nds.dirxml.driver.XmlDocument someDoc)
Sets the XML document associated with this exception. |
void |
setEventID(String someID)
Sents the event ID associated with this exception. |
void |
setLevel(StatusLevel someLevel)
Sets the status level of this exception. |
void |
setPrintStackTrace(boolean value)
Sets whether the stack trace of each contained Throwable
should be output? |
void |
setType(StatusType someType)
Sets the status type of this exception. |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int CAT_ERROR
public static final int CAT_AUTH
public static final int CAT_CONNECT
public static final int CAT_RETRY
public static final int CAT_FATAL
Constructor Detail |
public DriverException(String someMessage)
someMessage
- may be null
Method Detail |
public void appendPreMessage(String someMessage)
someMessage
- may be null
public void appendPostMessage(String someMessage)
someMessage
- may be null
public void addThrowables(List someThrowables)
Throwable
objects to this exception.
someThrowables
- may be null
public void addThrowble(Throwable someThrowable)
Throwable
object to this exception.
someThrowable
- may be null
public void setPrintStackTrace(boolean value)
Throwable
should be output?
value
- true
or false
public void setAppendDocument(boolean value)
value
- true
or false
public boolean getAppendDocument()
true
or false
public boolean getPrintStackTrace()
Throwable
be output?
true
or false
public List getThrowables()
List
of Throwables
contained
by this exception.
null
public void setLevel(StatusLevel someLevel)
someLevel
- may be null
public StatusLevel getLevel()
null
public void setType(StatusType someType)
someType
- may be null
public StatusType getType()
null
public void setCategory(int someCategory)
someCategory
- should be a legal value as defined in this classpublic boolean isFatal()
true
or false
public boolean isAuthenticationRelated()
true
or false
public boolean isConnectivityRelated()
true
or false
public boolean isSpecialCondition()
That is, does it represent a specific error condition or just a general one.
true
if specific; false
otherwisepublic boolean isRetry()
true
or false
public String getMessage()
null
public void setDocument(com.novell.nds.dirxml.driver.XmlDocument someDoc)
someDoc
- may be null
public com.novell.nds.dirxml.driver.XmlDocument getDocument()
null
public void setEventID(String someID)
someID
- may be null
public String getEventID()
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |