Copy as Markdown

On this page

DefaultExceptionContext

public class org.apache.commons.lang3.exception.DefaultExceptionContext implements ExceptionContext, Serializable

Default implementation of the context storing the label-value pairs for contexted exceptions.

This implementation is serializable, however this is dependent on the values that are added also being serializable.

See also:

• ContextedException

• ContextedRuntimeException

Since:

3.0

Constructors

DefaultExceptionContext()

Constructs a new instance.

public DefaultExceptionContext()

Constructs a new instance.

Methods

addContextValue(String, Object)	Adds a contextual label-value pair into this context.
getContextEntries()	Gets the full list of label-value pairs defined in the contextual data.
getContextLabels()	Gets the full set of labels defined in the contextual data.
getContextValues(String)	Gets all the contextual data values associated with the label.
getFirstContextValue(String)	Gets the first available contextual data value associated with the label.
getFormattedExceptionMessage(String)	Gets the message containing the contextual information.
setContextValue(String, Object)	Sets a contextual label-value pair into this context.

@Override public DefaultExceptionContext addContextValue(String label, Object value)

Adds a contextual label-value pair into this context.

The pair will be added to the context, independently of an already existing pair with the same label.

Parameters:

• label – The label of the item to add, null not recommended

• value – The value of item to add, may be null

Returns:

this, for method chaining, not null

@Override public List<Pair<String, Object>> getContextEntries()

Gets the full list of label-value pairs defined in the contextual data.

Returns:

The list of pairs, not null

@Override public Set<String> getContextLabels()

Gets the full set of labels defined in the contextual data.

Returns:

The set of labels, not null

@Override public List<Object> getContextValues(String label)

Gets all the contextual data values associated with the label.

Parameters:

label – The label to get the contextual values for, may be null

Returns:

The contextual values associated with the label, never null

@Override public Object getFirstContextValue(String label)

Gets the first available contextual data value associated with the label.

Parameters:

label – The label to get the contextual value for, may be null

Returns:

The first contextual value associated with the label, may be null

@Override public String getFormattedExceptionMessage(String baseMessage)

Gets the message containing the contextual information.

Parameters:

baseMessage – The base exception message without context information appended

Returns:

The exception message with context information appended, never null

@Override public DefaultExceptionContext setContextValue(String label, Object value)

Sets a contextual label-value pair into this context.

The pair will be added normally, but any existing label-value pair with the same label is removed from the context.

Parameters:

• label – The label of the item to add, null not recommended

• value – The value of item to add, may be null

Returns:

this, for method chaining, not null