Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/XmlID.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/XmlID.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 397
- b99d7e355d4b
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2004, 2013, 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 javax.xml.bind.annotation; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.lang.annotation.Target; |
| aoqi@0 | 29 | import java.lang.annotation.Retention; |
| aoqi@0 | 30 | import static java.lang.annotation.ElementType.*; |
| aoqi@0 | 31 | import static java.lang.annotation.RetentionPolicy.*; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * <p> |
| aoqi@0 | 35 | * Maps a JavaBean property to XML ID. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * <p> |
| aoqi@0 | 38 | * To preserve referential integrity of an object graph across XML |
| aoqi@0 | 39 | * serialization followed by a XML deserialization, requires an object |
| aoqi@0 | 40 | * reference to be marshalled by reference or containment |
| aoqi@0 | 41 | * appropriately. Annotations <tt>@XmlID</tt> and <tt>@XmlIDREF</tt> |
| aoqi@0 | 42 | * together allow a customized mapping of a JavaBean property's |
| aoqi@0 | 43 | * type by containment or reference. |
| aoqi@0 | 44 | * |
| aoqi@0 | 45 | * <p><b>Usage</b> </p> |
| aoqi@0 | 46 | * The <tt>@XmlID</tt> annotation can be used with the following |
| aoqi@0 | 47 | * program elements: |
| aoqi@0 | 48 | * <ul> |
| aoqi@0 | 49 | * <li> a JavaBean property </li> |
| aoqi@0 | 50 | * <li> non static, non transient field </li> |
| aoqi@0 | 51 | * </ul> |
| aoqi@0 | 52 | * |
| aoqi@0 | 53 | * <p>See "Package Specification" in javax.xml.bind.package javadoc for |
| aoqi@0 | 54 | * additional common information.</p> |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * The usage is subject to the following constraints: |
| aoqi@0 | 57 | * <ul> |
| aoqi@0 | 58 | * <li> At most one field or property in a class can be annotated |
| aoqi@0 | 59 | * with <tt>@XmlID</tt>. </li> |
| aoqi@0 | 60 | * <li> The JavaBean property's type must be <tt>java.lang.String</tt>.</li> |
| aoqi@0 | 61 | * <li> The only other mapping annotations that can be used |
| aoqi@0 | 62 | * with <tt>@XmlID</tt> |
| aoqi@0 | 63 | * are:<tt>@XmlElement</tt> and <tt>@XmlAttribute</tt>.</li> |
| aoqi@0 | 64 | * </ul> |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * <p><b>Example</b>: Map a JavaBean property's type to <tt>xs:ID</tt></p> |
| aoqi@0 | 67 | * <pre> |
| aoqi@0 | 68 | * // Example: code fragment |
| aoqi@0 | 69 | * public class Customer { |
| aoqi@0 | 70 | * @XmlAttribute |
| aoqi@0 | 71 | * @XmlID |
| aoqi@0 | 72 | * public String getCustomerID(); |
| aoqi@0 | 73 | * public void setCustomerID(String id); |
| aoqi@0 | 74 | * .... other properties not shown |
| aoqi@0 | 75 | * } |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * <!-- Example: XML Schema fragment --> |
| aoqi@0 | 78 | * <xs:complexType name="Customer"> |
| aoqi@0 | 79 | * <xs:complexContent> |
| aoqi@0 | 80 | * <xs:sequence> |
| aoqi@0 | 81 | * .... |
| aoqi@0 | 82 | * </xs:sequence> |
| aoqi@0 | 83 | * <xs:attribute name="customerID" type="xs:ID"/> |
| aoqi@0 | 84 | * </xs:complexContent> |
| aoqi@0 | 85 | * </xs:complexType> |
| aoqi@0 | 86 | * </pre> |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * @author Sekhar Vajjhala, Sun Microsystems, Inc. |
| aoqi@0 | 89 | * @see XmlIDREF |
| aoqi@0 | 90 | * @since JAXB2.0 |
| aoqi@0 | 91 | */ |
| aoqi@0 | 92 | |
| aoqi@0 | 93 | @Retention(RUNTIME) @Target({FIELD, METHOD}) |
| aoqi@0 | 94 | public @interface XmlID { } |
