• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/bind/annotation/XmlLocation.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/annotation/XmlLocation.java

Thu, 12 Oct 2017 19:44:07 +0800

author

aoqi

date

Thu, 12 Oct 2017 19:44:07 +0800

changeset 760

e530533619ec

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.bind.annotation;
aoqi@0	27
aoqi@0	28	import java.lang.annotation.Retention;
aoqi@0	29	import java.lang.annotation.Target;
aoqi@0	30
aoqi@0	31	import org.xml.sax.Locator;
aoqi@0	32
aoqi@0	33	import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0	34	import static java.lang.annotation.ElementType.FIELD;
aoqi@0	35	import static java.lang.annotation.ElementType.METHOD;
aoqi@0	36
aoqi@0	37	/**
aoqi@0	38	* Marks a property that receives a location from which the object is unmarshalled.
aoqi@0	39	*
aoqi@0	40	* <h2>Usage</h2>
aoqi@0	41	* <p>
aoqi@0	42	* The @XmlLocation can be specified on:
aoqi@0	43	* <ul>
aoqi@0	44	* <li>a field whose type is {@link Locator}, or
aoqi@0	45	* <li>a method that takes a {@link Locator} as the sole parameter
aoqi@0	46	* </ul>
aoqi@0	47	*
aoqi@0	48	* <p>
aoqi@0	49	* When a class that contains such a field/method is unmarshalled by the JAXB RI,
aoqi@0	50	* such a field/method will receive an immutable {@link Locator} object that describes
aoqi@0	51	* the location in the XML document where the object is unmarshalled from.
aoqi@0	52	*
aoqi@0	53	* <p>
aoqi@0	54	* If the unmarshaller does not know the source location information, the locator
aoqi@0	55	* will not be set. For example, this happens when it is unmarshalling from a DOM tree.
aoqi@0	56	* This also happens if you use JAXB implementations other than the JAXB RI.
aoqi@0	57	*
aoqi@0	58	* <p>
aoqi@0	59	* This information can be used by applications, for example to provide user-friendly
aoqi@0	60	* error information.
aoqi@0	61	*
aoqi@0	62	*
aoqi@0	63	* @author Kohsuke Kawaguchi
aoqi@0	64	* @since JAXB RI 2.0 EA
aoqi@0	65	*/
aoqi@0	66	@Retention(RUNTIME) @Target({FIELD,METHOD})
aoqi@0	67	public @interface XmlLocation {
aoqi@0	68	}