Package com.thoughtworks.xstream.converters

Class ErrorWritingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.thoughtworks.xstream.core.BaseException

com.thoughtworks.xstream.XStreamException

com.thoughtworks.xstream.converters.ErrorWritingException

All Implemented Interfaces:

ErrorWriter, java.io.Serializable

Direct Known Subclasses:

ConversionException, ObjectAccessException

public abstract class ErrorWritingException
extends XStreamException
implements ErrorWriter

Abstract base class for exceptions supporting an ErrorWriter. It can be passed around to things accepting an ErrorWriter to add diagnostics.

Since:

1.4.9

Author:

Jörg Schaible

See Also:

ErrorWriter, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ErrorWritingException(java.lang.String message)	Constructs a ErrorWritingException.
ErrorWritingException(java.lang.String message, java.lang.Throwable cause)	Constructs a ErrorWritingException.
ErrorWritingException(java.lang.Throwable cause)	Constructs a ErrorWritingException.

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String name, java.lang.String information)	Add some information to the error message.
java.lang.String	get(java.lang.String errorKey)	Retrieve information of the error message.
java.lang.String	getMessage()
java.lang.String	getShortMessage()
java.util.Iterator	keys()	Retrieve an iterator over all keys of the error message.
void	set(java.lang.String name, java.lang.String information)	Set some information to the error message.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorWritingException

public ErrorWritingException(java.lang.String message)

Constructs a ErrorWritingException.

Parameters:

message - the error message

Since:

1.4.9

ErrorWritingException

public ErrorWritingException(java.lang.Throwable cause)

Constructs a ErrorWritingException.

Parameters:

cause - the causing exception

Since:

1.4.9

ErrorWritingException

public ErrorWritingException(java.lang.String message,
                             java.lang.Throwable cause)

Constructs a ErrorWritingException.

Parameters:

message - the error message

cause - the causing exception

Since:

1.4.9

Method Detail

get

public java.lang.String get(java.lang.String errorKey)

Description copied from interface: ErrorWriter

Retrieve information of the error message.

Specified by:

get in interface ErrorWriter

Parameters:

errorKey - the key of the message

Returns:

the value

add

public void add(java.lang.String name,
                java.lang.String information)

Description copied from interface: ErrorWriter

Add some information to the error message. The information will be added even if the identifier is already in use.

Specified by:

add in interface ErrorWriter

Parameters:

name - something to identify the type of information (e.g. 'XPath').

information - detail of the message (e.g. '/blah/moo[3]'

set

public void set(java.lang.String name,
                java.lang.String information)

Description copied from interface: ErrorWriter

Set some information to the error message. If the identifier is already in use, the new information will replace the old one.

Specified by:

set in interface ErrorWriter

Parameters:

name - something to identify the type of information (e.g. 'XPath').

information - detail of the message (e.g. '/blah/moo[3]'

keys

public java.util.Iterator keys()

Description copied from interface: ErrorWriter

Retrieve an iterator over all keys of the error message.

Specified by:

keys in interface ErrorWriter

Returns:

an Iterator

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getShortMessage

public java.lang.String getShortMessage()