public class DefaultExceptionContext extends Object implements ExceptionContext, Serializable
This implementation is serializable, however this is dependent on the values that are added also being serializable.
ContextedException
,
ContextedRuntimeException
,
Serialized FormConstructor and Description |
---|
DefaultExceptionContext() |
Modifier and Type | Method and Description |
---|---|
DefaultExceptionContext |
addContextValue(String label,
Object value)
Adds a contextual label-value pair into this context.
|
List<Pair<String,Object>> |
getContextEntries()
Retrieves the full list of label-value pairs defined in the contextual data.
|
Set<String> |
getContextLabels()
Retrieves the full set of labels defined in the contextual data.
|
List<Object> |
getContextValues(String label)
Retrieves all the contextual data values associated with the label.
|
Object |
getFirstContextValue(String label)
Retrieves the first available contextual data value associated with the label.
|
String |
getFormattedExceptionMessage(String baseMessage)
Builds the message containing the contextual information.
|
DefaultExceptionContext |
setContextValue(String label,
Object value)
Sets a contextual label-value pair into this context.
|
public DefaultExceptionContext()
public DefaultExceptionContext addContextValue(String label, Object value)
The pair will be added to the context, independently of an already existing pair with the same label.
addContextValue
in interface ExceptionContext
label
- the label of the item to add, null
not recommendedvalue
- the value of item to add, may be null
this
, for method chaining, not null
public DefaultExceptionContext setContextValue(String label, Object value)
The pair will be added normally, but any existing label-value pair with the same label is removed from the context.
setContextValue
in interface ExceptionContext
label
- the label of the item to add, null
not recommendedvalue
- the value of item to add, may be null
this
, for method chaining, not null
public List<Object> getContextValues(String label)
getContextValues
in interface ExceptionContext
label
- the label to get the contextual values for, may be null
null
public Object getFirstContextValue(String label)
getFirstContextValue
in interface ExceptionContext
label
- the label to get the contextual value for, may be null
null
public Set<String> getContextLabels()
getContextLabels
in interface ExceptionContext
null
public List<Pair<String,Object>> getContextEntries()
getContextEntries
in interface ExceptionContext
null
public String getFormattedExceptionMessage(String baseMessage)
getFormattedExceptionMessage
in interface ExceptionContext
baseMessage
- the base exception message without context information appendedCopyright © 2001–2014 The Apache Software Foundation. All rights reserved.