Class UnmarshalException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

org.refcodes.exception.UnmarshalException

All Implemented Interfaces:

Serializable, ErrorCodeAccessor, Trap

public class UnmarshalException
extends AbstractException

Thrown when unmarshaling / deserializing an object fails.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ErrorCodeAccessor

ErrorCodeAccessor.ErrorCodeBuilder<B>, ErrorCodeAccessor.ErrorCodeMutator, ErrorCodeAccessor.ErrorCodeProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_offset

Constructor Summary

Constructors

Constructor	Description
UnmarshalException(String aMessage)	Instantiates the class UnmarshalException.
UnmarshalException(String aMessage, int aOffset)	Instantiates the class UnmarshalException.
UnmarshalException(String aMessage, int aOffset, Throwable aCause)	Instantiates the class UnmarshalException.
UnmarshalException(String aMessage, String aErrorCode)	Instantiates the class UnmarshalException.
UnmarshalException(String aMessage, Throwable aCause)	Instantiates the class UnmarshalException.
UnmarshalException(String aMessage, Throwable aCause, String aErrorCode)	Instantiates the class UnmarshalException.
UnmarshalException(Throwable aCause)	Instantiates the class UnmarshalException.
UnmarshalException(Throwable aCause, String aErrorCode)	Instantiates the class UnmarshalException.

Method Summary

Modifier and Type	Method	Description
int	getOffset()	In case of a char sequence, the offset represents the position at which unmarshaling failed.
Object[]	getPatternArguments()	Provides the arguments for the Throwable.getMessage() method to create the actual message from the message pattern (passed as message argument to the exception's constructors).

Methods inherited from class AbstractException

getErrorCode, getMessage

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Methods inherited from interface Trap

toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Field Details

_offset

protected int _offset

Constructor Details

UnmarshalException

public UnmarshalException(String aMessage)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(String)

UnmarshalException

public UnmarshalException(String aMessage,
 int aOffset,
 Throwable aCause)

Instantiates the class UnmarshalException.

Parameters:

aOffset - The offset in the char sequence causing problems.

See Also:

• AbstractException(String, Throwable)

UnmarshalException

public UnmarshalException(String aMessage,
 int aOffset)

Instantiates the class UnmarshalException.

Parameters:

aOffset - The offset in the char sequence causing problems.

See Also:

• AbstractException(String)

UnmarshalException

public UnmarshalException(String aMessage,
 Throwable aCause)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(String, Throwable)

UnmarshalException

public UnmarshalException(Throwable aCause)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(Throwable)

UnmarshalException

public UnmarshalException(String aMessage,
 String aErrorCode)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(String, String)

UnmarshalException

public UnmarshalException(String aMessage,
 Throwable aCause,
 String aErrorCode)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(String, Throwable, String)

UnmarshalException

public UnmarshalException(Throwable aCause,
 String aErrorCode)

Instantiates the class UnmarshalException.

See Also:

• AbstractException(Throwable, String)

Method Details

getOffset

public int getOffset()

In case of a char sequence, the offset represents the position at which unmarshaling failed.

Returns:

The position at which unmarshaling failed or -1 if none such position is available.

getPatternArguments

public Object[] getPatternArguments()

Provides the arguments for the Throwable.getMessage() method to create the actual message from the message pattern (passed as message argument to the exception's constructors). The message pattern together with the arguments are passed to the Trap.asMessage(String, Object...) method). Override the Trap.getPatternArguments() method to provide the required arguments for applying Trap.asMessage(String, Object...) to the message template! Providing null will return the message pattern untouched.

Returns:

The arguments required to build a message from the message pattern or null if the message pattern is to be returned directly!