01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.bind.annotation;
38:
39: import java.lang.annotation.Retention;
40: import java.lang.annotation.Target;
41:
42: import org.xml.sax.Locator;
43:
44: import static java.lang.annotation.RetentionPolicy.RUNTIME;
45: import static java.lang.annotation.ElementType.FIELD;
46: import static java.lang.annotation.ElementType.METHOD;
47:
48: /**
49: * Marks a property that receives a location from which the object is unmarshalled.
50: *
51: * <h2>Usage</h2>
52: * <p>
53: * The @XmlLocation can be specified on:
54: * <ul>
55: * <li>a field whose type is {@link Locator}, or
56: * <li>a method that takes a {@link Locator} as the sole parameter
57: * </ul>
58: *
59: * <p>
60: * When a class that contains such a field/method is unmarshalled by the JAXB RI,
61: * such a field/method will receive an immutable {@link Locator} object that describes
62: * the location in the XML document where the object is unmarshalled from.
63: *
64: * <p>
65: * If the unmarshaller does not know the source location information, the locator
66: * will not be set. For example, this happens when it is unmarshalling from a DOM tree.
67: * This also happens if you use JAXB implementations other than the JAXB RI.
68: *
69: * <p>
70: * This information can be used by applications, for example to provide user-friendly
71: * error information.
72: *
73: *
74: * @author Kohsuke Kawaguchi
75: * @since JAXB RI 2.0 EA
76: */
77: @Retention(RUNTIME)
78: @Target({FIELD,METHOD})
79: public @interface XmlLocation {
80: }
|