org.glassfish.jaxb.core.annotation.XmlLocation Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.glassfish.jaxb.core.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.xml.sax.Locator;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
/**
* 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 {@link Locator}, or
*
- a method that takes a {@link 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 {@link 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.
*
*
* @author Kohsuke Kawaguchi
* @since JAXB RI 2.0 EA
*/
@Retention(RUNTIME) @Target({FIELD,METHOD})
public @interface XmlLocation {
}