|
||||||||||
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.eclipse.birt.core.exception.BirtException
public class BirtException
Define BIRT's Exception framework. Every BIRT exception has to include an error code, which is a string. Different BIRT modules use different prefix for error codes. For example,
Field Summary | |
---|---|
static int |
CANCEL
Status type severity (bit mask, value 8) indicating this exception represents a cancelation |
static int |
ERROR
Status type severity (bit mask, value 4) indicating this exception represents an error. |
static int |
INFO
Status type severity (bit mask, value 1) indicating this exception is informational only. |
protected java.lang.Object[] |
oaMessageArguments
Optional arguments to be used with a resource key to build the error message |
static int |
OK
Status severity constant (value 0) indicating this exception represents the nominal case. |
protected java.lang.String |
pluginId
The unique identifier of the plug-in associated with this exception |
protected java.util.ResourceBundle |
rb
The resource bundle that holds a collection of messages for a specific locale |
protected int |
severity
The severity of this exception. |
protected java.lang.String |
sResourceKey
The resource key that represents the internal error code used in fetching an externalized message |
static int |
WARNING
Status type severity (bit mask, value 2) indicating this exception represents a warning. |
Constructor Summary | |
---|---|
BirtException()
|
|
BirtException(java.lang.String errorCode,
java.lang.Object arg0)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.lang.Object[] args,
java.util.ResourceBundle bundle)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.lang.Object[] args,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.lang.Object[] args,
java.lang.Throwable cause)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.lang.Object arg0,
java.util.ResourceBundle bundle)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.lang.Object arg0,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
Deprecated. |
|
BirtException(java.lang.String errorCode,
java.util.ResourceBundle bundle)
Deprecated. Constructs a new Birt exception with no cause object. |
|
BirtException(java.lang.String errorCode,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
Deprecated. |
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object arg0)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object[] args,
java.util.ResourceBundle bundle)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object[] args,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object[] args,
java.lang.Throwable cause)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object arg0,
java.util.ResourceBundle bundle)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.lang.Object arg0,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
|
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.util.ResourceBundle bundle)
Constructs a new Birt exception with no cause object. |
|
BirtException(java.lang.String pluginId,
java.lang.String errorCode,
java.util.ResourceBundle bundle,
java.lang.Throwable cause)
|
Method Summary | |
---|---|
java.lang.String |
getErrorCode()
|
java.lang.String |
getLocalizedMessage()
|
protected java.lang.String |
getLocalizedMessage(java.lang.String errorCode)
Returns a localized message based on an error code. |
java.lang.String |
getMessage()
|
java.lang.String |
getPluginId()
Returns the unique identifier of the plug-in associated with this exception (this is the plug-in that defines the meaning of the error code). |
int |
getSeverity()
Returns the severity. |
void |
setSeverity(int severity)
Sets the severity of the exception. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, 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 |
---|
protected final java.lang.String sResourceKey
protected final java.lang.Object[] oaMessageArguments
protected final transient java.util.ResourceBundle rb
protected java.lang.String pluginId
protected int severity
CANCEL
ERROR
(default value)WARNING
INFO
OK
(0)
public static final int OK
getSeverity()
,
Constant Field Valuespublic static final int INFO
getSeverity()
,
Constant Field Valuespublic static final int WARNING
getSeverity()
,
Constant Field Valuespublic static final int ERROR
getSeverity()
,
Constant Field Valuespublic static final int CANCEL
getSeverity()
,
Constant Field ValuesConstructor Detail |
---|
public BirtException(java.lang.String errorCode, java.util.ResourceBundle bundle)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.public BirtException(java.lang.String errorCode, java.util.ResourceBundle bundle, java.lang.Throwable cause)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionpublic BirtException(java.lang.String errorCode, java.lang.Object[] args, java.util.ResourceBundle bundle, java.lang.Throwable cause)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.args
- string arguments used to format error messagespublic BirtException(java.lang.String errorCode, java.lang.Object arg0, java.util.ResourceBundle bundle, java.lang.Throwable cause)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionarg0
- first argument used to format error messagespublic BirtException(java.lang.String errorCode, java.lang.Object[] args, java.util.ResourceBundle bundle)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.args
- string arguments used to format error messagespublic BirtException(java.lang.String errorCode, java.lang.Object arg0, java.util.ResourceBundle bundle)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionarg0
- first argument used to format error messagespublic BirtException(java.lang.String errorCode, java.lang.Object arg0)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.arg0
- first argument used to format error messagespublic BirtException(java.lang.String errorCode, java.lang.Object[] args, java.lang.Throwable cause)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.cause
- the nested exceptionargs
- string arguments used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.util.ResourceBundle bundle)
pluginId
- Returns the unique identifier of the plug-in associated with
this exception *errorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.public BirtException()
public BirtException(java.lang.String pluginId, java.lang.String errorCode, java.util.ResourceBundle bundle, java.lang.Throwable cause)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionerrorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionpublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object[] args, java.util.ResourceBundle bundle, java.lang.Throwable cause)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionerrorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.args
- string arguments used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object arg0, java.util.ResourceBundle bundle, java.lang.Throwable cause)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionerrorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionarg0
- first argument used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object[] args, java.util.ResourceBundle bundle)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionerrorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.args
- string arguments used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object arg0, java.util.ResourceBundle bundle)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionerrorCode
- used to retrieve a piece of externalized message displayed to
end user.resourceBundle
- the resourceBundle used to translate the message.cause
- the nested exceptionarg0
- first argument used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object arg0)
pluginId
- Returns the unique identifier of the plug-in associated with
this exceptionseverity
- errorCode
- used to retrieve a piece of externalized message displayed to
end user.arg0
- first argument used to format error messagespublic BirtException(java.lang.String pluginId, java.lang.String errorCode, java.lang.Object[] args, java.lang.Throwable cause)
errorCode
- used to retrieve a piece of externalized message displayed to
end user.cause
- the nested exceptionargs
- string arguments used to format error messagesMethod Detail |
---|
public java.lang.String getErrorCode()
public java.lang.String getLocalizedMessage()
getLocalizedMessage
in class java.lang.Throwable
public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
protected java.lang.String getLocalizedMessage(java.lang.String errorCode)
errorCode
- the error code
public java.lang.String getPluginId()
public int getSeverity()
CANCEL
- cancelation occurredERROR
- a serious error (most severe)WARNING
- a warning (less severe)INFO
- an informational ("fyi") message (least
severe)OK
- everything is just fine
OK
,ERROR
,
INFO
,WARNING
, or
CANCEL
public void setSeverity(int severity)
severity
- the severity; one of OK
,ERROR
,
INFO
,WARNING
, or
CANCEL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |