public abstract class BIBaseException extends java.lang.Exception implements BIException
Modifier and Type | Field and Description |
---|---|
protected BIExceptionSupport |
m_support |
Constructor and Description |
---|
BIBaseException(java.lang.String s,
java.lang.Throwable prevException)
Constructor for an exception that displays a customized message and that
passes on an underlying exception.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Throwable |
elementAt(int index)
Retrieves the exception at the specified index.
|
java.util.Enumeration |
elements()
Retrieves An enumeration of exceptions in the exception chain.
|
BIException |
findException(int nErrorCode)
Determines whether the specified error code appears in the
BIException
exception stack. |
java.lang.Throwable |
getBIRootCause()
Retrieves the root exception.
|
BIException |
getException(java.lang.String strMessage) |
java.lang.Throwable |
getPreviousException()
Retrieves the underlying exception, if one exists.
|
void |
printStackTrace() |
void |
printStackTrace(java.io.PrintWriter pw) |
void |
printStackTraceSuper() |
void |
printStackTraceSuper(java.io.PrintWriter pw) |
int |
size()
Retrieves the size of the exception chain.
|
java.lang.String |
toString()
Retrieves the exception stack.
|
protected BIExceptionSupport m_support
public BIBaseException(java.lang.String s, java.lang.Throwable prevException)
s
- The customized message.prevException
- The exception that underlies this exception.public void printStackTrace()
printStackTrace
in class java.lang.Throwable
public void printStackTrace(java.io.PrintWriter pw)
printStackTrace
in class java.lang.Throwable
public void printStackTraceSuper(java.io.PrintWriter pw)
public void printStackTraceSuper()
public java.lang.Throwable getPreviousException()
getPreviousException
in interface BIException
null
.public java.lang.String toString()
toString
in interface BIException
toString
in class java.lang.Throwable
public java.lang.Throwable getBIRootCause()
getBIRootCause
in interface BIException
public java.lang.Throwable elementAt(int index)
elementAt
in interface BIException
public java.util.Enumeration elements()
elements
in interface BIException
public int size()
size
in interface BIException
public BIException getException(java.lang.String strMessage)
strMessage
- A String
which represents the string to
find in the BIException
.BIException
that is associated with the specified
message string, or null.BIException
stack.
This is particularly useful when the string used to create the
BIException
represents an error code that is used to lookup
the associated error string.
For example, in the following error, 'DVT-15000' which is represented by the
EXC_METADATAMANAGER_NOT_SET literal would represent the error
code:
DVT-15000 MetadataManager property not set.
public static final String EXC_METADATAMANAGER_NOT_SET = "DVT-15000";
BIException biException = getException (EXC_METADATAMANAGER_NOT_SET);public BIException findException(int nErrorCode)
BIException
exception stack.
For example, if we were looking for a 'DVT-15000 MetadataManager property not set.'
exception, we would pass in an error code value of '15000':
BIException biException = findException (15000);nErrorCode
- A int
which represents the error code to
find in the BIException
stack.BIException
that is associated with the specified
error code, or null.