public interface JboMessage
Message-text localization occurs when
the client calls getLocalizedMessage()
, rather than at
the time the exception occurs, because the client may need to present the message in
a number of different languages.
Modifier and Type | Method and Description |
---|---|
void |
addToDetails(java.lang.Object obj)
Adds to the list of details.
|
java.lang.String |
getBaseMessage()
Gets the message without localizing it or inserting parameters.
|
java.lang.String |
getDetailMessage()
Converts the message to text, incorporating the list of details.
|
java.lang.Object[] |
getDetails()
Gets the list of objects and exceptions that spawned this message.
|
java.lang.String |
getErrorCode()
Gets the message's error code.
|
java.lang.Object[] |
getErrorParameters()
Gets the message's parameters.
|
java.lang.String |
getLocalizedBaseMessage(java.util.Locale l)
Localizes an un-parameterized message text for a specific
Locale . |
java.lang.String |
getLocalizedMessage(java.util.Locale l)
Formats the message text for a specific
Locale . |
java.lang.String |
getMessage()
Formats the message text for the default locale.
|
java.lang.String |
getProductCode()
Gets the product code.
|
java.lang.Class |
getResourceClass()
Gets the resource bundle used to localize messages.
|
java.lang.String |
getResourceName()
Gets the name of the
ResourceBundle used to localize messages. |
boolean |
isLocalizable()
Tests this message's localizability.
|
void |
setDetails(java.lang.Object[] details)
Sets the list of details.
|
java.lang.String getMessage()
java.lang.String getLocalizedMessage(java.util.Locale l)
Locale
.l
- a locale.java.lang.String getBaseMessage()
java.lang.String getLocalizedBaseMessage(java.util.Locale l)
Locale
.l
- a locale.java.lang.Class getResourceClass()
ResourceBundle
subclass.java.lang.String getResourceName()
ResourceBundle
used to localize messages.java.lang.String getErrorCode()
java.lang.Object[] getErrorParameters()
java.lang.String getProductCode()
java.lang.Object[] getDetails()
java.lang.String getDetailMessage()
void setDetails(java.lang.Object[] details)
details
- an array which replaces the current list of details.
array in this exception object.void addToDetails(java.lang.Object obj)
obj
- an object to add to the details list.boolean isLocalizable()
true
if this message can be localized.