Interface ErrorWriter
- All Known Implementing Classes:
AbstractReferenceMarshaller.ReferencedImplicitElementException
,AbstractReflectionConverter.DuplicateFieldException
,AbstractReflectionConverter.UnknownFieldException
,ConversionException
,ErrorWritingException
,JavaBeanConverter.DuplicateFieldException
,JavaBeanConverter.DuplicatePropertyException
,MissingFieldException
,ObjectAccessException
,TreeMarshaller.CircularReferenceException
public interface ErrorWriter
To aid debugging, some components are passed an ErrorWriter
when things go wrong, allowing them to add information
to the error message that may be helpful to diagnose problems.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add some information to the error message.Retrieve information of the error message.keys()
Retrieve an iterator over all keys of the error message.void
Set some information to the error message.
-
Method Details
-
add
Add some information to the error message. The information will be added even if the identifier is already in use.- Parameters:
name
- something to identify the type of information (e.g. 'XPath').information
- detail of the message (e.g. '/blah/moo[3]'
-
set
Set some information to the error message. If the identifier is already in use, the new information will replace the old one.- Parameters:
name
- something to identify the type of information (e.g. 'XPath').information
- detail of the message (e.g. '/blah/moo[3]'- Since:
- 1.4
-
get
Retrieve information of the error message.- Parameters:
errorKey
- the key of the message- Returns:
- the value
- Since:
- 1.3
-
keys
Iterator keys()Retrieve an iterator over all keys of the error message.- Returns:
- an Iterator
- Since:
- 1.3
-