aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.annotation;
aoqi@0: 
aoqi@0: import java.lang.annotation.Retention;
aoqi@0: import java.lang.annotation.Target;
aoqi@0: 
aoqi@0: import org.xml.sax.Locator;
aoqi@0: 
aoqi@0: import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0: import static java.lang.annotation.ElementType.FIELD;
aoqi@0: import static java.lang.annotation.ElementType.METHOD;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Marks a property that receives a location from which the object is unmarshalled.
aoqi@0:  *
aoqi@0:  * <h2>Usage</h2>
aoqi@0:  * <p>
aoqi@0:  * The @XmlLocation can be specified on:
aoqi@0:  * <ul>
aoqi@0:  *  <li>a field whose type is {@link Locator}, or
aoqi@0:  *  <li>a method that takes a {@link Locator} as the sole parameter
aoqi@0:  * </ul>
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * When a class that contains such a field/method is unmarshalled by the JAXB RI,
aoqi@0:  * such a field/method will receive an immutable {@link Locator} object that describes
aoqi@0:  * the location in the XML document where the object is unmarshalled from.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * If the unmarshaller does not know the source location information, the locator
aoqi@0:  * will not be set. For example, this happens when it is unmarshalling from a DOM tree.
aoqi@0:  * This also happens if you use JAXB implementations other than the JAXB RI.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This information can be used by applications, for example to provide user-friendly
aoqi@0:  * error information.
aoqi@0:  *
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @since JAXB RI 2.0 EA
aoqi@0:  */
aoqi@0: @Retention(RUNTIME) @Target({FIELD,METHOD})
aoqi@0: public @interface XmlLocation {
aoqi@0: }