Class ExceptionContext
java.lang.Object
org.apache.commons.math3.exception.util.ExceptionContext
- All Implemented Interfaces:
Serializable
Class that contains the actual implementation of the functionality mandated
by the
ExceptionContext
interface.
All Commons Math exceptions delegate the interface's methods to this class.- Since:
- 3.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionArbitrary context information.Various informations that enrich the informative message.private List
<Localizable> Various informations that enrich the informative message.private static final long
Serializable version Id.private Throwable
The throwable to which this context refers to. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addMessage
(Localizable pattern, Object... arguments) Adds a message.private String
buildMessage
(Locale locale, String separator) Builds a message string.private void
Deserializecontext
.private void
DeserializemsgPatterns
andmsgArguments
.getKeys()
Gets all the keys stored in the exceptionGets the message in the default locale.Gets the default message.getMessage
(Locale locale) Gets the message in a specified locale.getMessage
(Locale locale, String separator) Gets the message in a specified locale.Get a reference to the exception to which the context relates.Gets the value associated to the given context key.private String
Replaces a non-serializable object with an error message string.private void
Deserialize this object from the given stream.private void
Serializecontext
.private void
SerializemsgPatterns
andmsgArguments
.void
Sets the context (key, value) pair.private void
Serialize this object to the given stream.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerializable version Id.- See Also:
-
throwable
The throwable to which this context refers to. -
msgPatterns
Various informations that enrich the informative message. -
msgArguments
Various informations that enrich the informative message. The arguments will replace the corresponding place-holders inmsgPatterns
. -
context
Arbitrary context information.
-
-
Constructor Details
-
ExceptionContext
Simple constructor.- Parameters:
throwable
- the exception this context refers too
-
-
Method Details
-
getThrowable
Get a reference to the exception to which the context relates.- Returns:
- a reference to the exception to which the context relates
-
addMessage
Adds a message.- Parameters:
pattern
- Message pattern.arguments
- Values for replacing the placeholders in the message pattern.
-
setValue
Sets the context (key, value) pair. Keys are assumed to be unique within an instance. If the same key is assigned a new value, the previous one will be lost.- Parameters:
key
- Context key (not null).value
- Context value.
-
getValue
Gets the value associated to the given context key.- Parameters:
key
- Context key.- Returns:
- the context value or
null
if the key does not exist.
-
getKeys
Gets all the keys stored in the exception- Returns:
- the set of keys.
-
getMessage
Gets the default message.- Returns:
- the message.
-
getLocalizedMessage
Gets the message in the default locale.- Returns:
- the localized message.
-
getMessage
Gets the message in a specified locale.- Parameters:
locale
- Locale in which the message should be translated.- Returns:
- the localized message.
-
getMessage
Gets the message in a specified locale.- Parameters:
locale
- Locale in which the message should be translated.separator
- Separator inserted between the message parts.- Returns:
- the localized message.
-
buildMessage
Builds a message string.- Parameters:
locale
- Locale in which the message should be translated.separator
- Message separator.- Returns:
- a localized message string.
-
writeObject
Serialize this object to the given stream.- Parameters:
out
- Stream.- Throws:
IOException
- This should never happen.
-
readObject
Deserialize this object from the given stream.- Parameters:
in
- Stream.- Throws:
IOException
- This should never happen.ClassNotFoundException
- This should never happen.
-
serializeMessages
SerializemsgPatterns
andmsgArguments
.- Parameters:
out
- Stream.- Throws:
IOException
- This should never happen.
-
deSerializeMessages
DeserializemsgPatterns
andmsgArguments
.- Parameters:
in
- Stream.- Throws:
IOException
- This should never happen.ClassNotFoundException
- This should never happen.
-
serializeContext
Serializecontext
.- Parameters:
out
- Stream.- Throws:
IOException
- This should never happen.
-
deSerializeContext
Deserializecontext
.- Parameters:
in
- Stream.- Throws:
IOException
- This should never happen.ClassNotFoundException
- This should never happen.
-
nonSerializableReplacement
Replaces a non-serializable object with an error message string.- Parameters:
obj
- Object that does not implement theSerializable
interface.- Returns:
- a string that mentions which class could not be serialized.
-