net.sf.practicalxml.converter

Class ConversionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.practicalxml.converter.ConversionException

All Implemented Interfaces:

Serializable

public class ConversionException
extends RuntimeException

A runtime exception thrown for any conversion error. Will always have a message, and typically contains a wrapped exception. Also contains information about the field that caused the exception:

• During Bean->XML conversion, contains the dot-delimited path of the field that caused the exception.
• During XML->Bean conversion, contains the absolute XPath of the node that caused the exception.

Since:

1.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConversionException(ConversionException source, String field) This constructor is invoked from Bean->XML conversions, to prepend a field component to the location before rethrowing the exception.
ConversionException(String message) This constructor is called from code that is not location-aware.
ConversionException(String message, Element elem) This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.
ConversionException(String message, Element elem, Throwable cause) This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.
ConversionException(String message, String field) This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.
ConversionException(String message, String field, Throwable cause) This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.
ConversionException(String message, Throwable cause) This constructor is called from code that is not location-aware.

Method Summary

Methods

Modifier and Type	Method and Description
String	getField() Returns the name of the field where this exception occurred, null if unknown.
String	getXPath() Returns the XPath of the node causing this exception, null if unknown.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

ConversionException

public ConversionException(String message)

This constructor is called from code that is not location-aware. Instances from this constructor will typically be caught by code that is, and rethrown in a location-aware instance.

Parameters:

message - The base message describing the exception.

ConversionException

public ConversionException(String message,
                   Throwable cause)

This constructor is called from code that is not location-aware. Instances from this constructor will typically be caught by code that is, and rethrown in a location-aware instance.

Parameters:

message - The base message describing the exception.

cause - The underlying cause of the exception.

ConversionException

public ConversionException(String message,
                   Element elem)

This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.

Parameters:

message - The base message describing the exception.

elem - The DOM element where the failure took place.

ConversionException

public ConversionException(String message,
                   Element elem,
                   Throwable cause)

This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.

Parameters:

message - The base message describing the exception.

elem - The DOM element where the failure took place.

cause - The underlying cause of the exception.

ConversionException

public ConversionException(String message,
                   String field)

This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.

Parameters:

message - The base message describing the exception.

field - The name of the field where the failure occurred.

ConversionException

public ConversionException(String message,
                   String field,
                   Throwable cause)

This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.

Parameters:

message - The base message describing the exception.

field - The name of the field where the failure occurred.

cause - The underlying cause of the exception.

ConversionException

public ConversionException(ConversionException source,
                   String field)

This constructor is invoked from Bean->XML conversions, to prepend a field component to the location before rethrowing the exception.

Parameters:

source - The original exception.

field - The name of the field component to prepend.

Method Detail

getXPath

public String getXPath()

Returns the XPath of the node causing this exception, null if unknown.

getField

public String getField()

Returns the name of the field where this exception occurred, null if unknown.