com.sun.xml.bind.annotation

Annotation Type XmlLocation

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface XmlLocation

Marks a property that receives a location from which the object is unmarshalled.

Usage

The @XmlLocation can be specified on:

• a field whose type is Locator, or
• a method that takes a Locator as the sole parameter

When a class that contains such a field/method is unmarshalled by the JAXB RI, such a field/method will receive an immutable Locator object that describes the location in the XML document where the object is unmarshalled from.

If the unmarshaller does not know the source location information, the locator will not be set. For example, this happens when it is unmarshalling from a DOM tree. This also happens if you use JAXB implementations other than the JAXB RI.

This information can be used by applications, for example to provide user-friendly error information.

Since:

JAXB RI 2.0 EA

Author:

Kohsuke Kawaguchi