com.sun.xml.bind.v2.runtime

Class IllegalAnnotationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.xml.bind.JAXBException

com.sun.xml.bind.v2.runtime.IllegalAnnotationException

All Implemented Interfaces:

Serializable

public class IllegalAnnotationException
extends JAXBException

Signals an incorrect use of JAXB annotations.

Since:

JAXB 2.0 EA1

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IllegalAnnotationException(String message, Annotation src)
IllegalAnnotationException(String message, Annotation src1, Annotation src2)
IllegalAnnotationException(String message, Annotation src1, Locatable src2)
IllegalAnnotationException(String message, Locatable src)
IllegalAnnotationException(String message, Locatable src1, Locatable src2)
IllegalAnnotationException(String message, Throwable cause, Locatable src)

Method Summary

Modifier and Type	Method and Description
List<List<Location>>	getSourcePos() Returns a read-only list of Location that indicates where in the source code the problem has happened.
String	toString() Returns the exception name, message, and related information together in one string.

Methods inherited from class javax.xml.bind.JAXBException

getCause, getErrorCode, getLinkedException, printStackTrace, printStackTrace, printStackTrace, setLinkedException

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Locatable src)

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Annotation src)

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Locatable src1,
                                  Locatable src2)

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Annotation src1,
                                  Annotation src2)

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Annotation src1,
                                  Locatable src2)

IllegalAnnotationException

public IllegalAnnotationException(String message,
                                  Throwable cause,
                                  Locatable src)

Method Detail

getSourcePos

public List<List<Location>> getSourcePos()

Returns a read-only list of Location that indicates where in the source code the problem has happened.

Normally, an annotation error happens on one particular annotation, in which case this method returns a list that contains another list, which in turn contains the location information that leads to the error location (IOW, [ [pos1,pos2,...,posN] ])

Sometimes, an error could occur because of two or more conflicting annotations, in which case this method returns a list that contains many lists, where each list contains the location information that leads to each of the conflicting annotations (IOW, [ [pos11,pos12,...,pos1N],[pos21,pos22,...,pos2M], ... ])

Yet some other time, the runtime can fail to provide any error location, in which case this method returns an empty list. (IOW, []). We do try hard to make sure this won't happen, so please let us know if you see this behavior.

List of Location

Each error location is identified not just by one Location object, but by a sequence of Locations that shows why the runtime is led to the place of the error. This list is sorted such that the most specific Location comes to the first in the list, sort of like a stack trace.

For example, suppose you specify class Foo to JAXBContext, Foo derives from Bar, Bar has a field pea that points to Zot, Zot contains a gum property, and this property has an errornous annotation. Then when this exception is thrown, the list of Locations will look something like [ "gum property", "Zot class", "pea property", "Bar class", "Foo class" ]

Returns:

can be empty when no source position is available, but never null. The returned list will never contain null nor length-0 List.

toString

public String toString()

Returns the exception name, message, and related information together in one string.

Overriding this method (instead of JAXBException.printStackTrace(java.io.PrintStream) allows this crucial detail to show up even when this exception is nested inside other exceptions.

Overrides:

toString in class JAXBException