/*
 * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.bind.annotation;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

Maps a JavaBean property to XML ID.

To preserve referential integrity of an object graph across XML serialization followed by a XML deserialization, requires an object reference to be marshalled by reference or containment appropriately. Annotations @XmlID and @XmlIDREF together allow a customized mapping of a JavaBean property's type by containment or reference.

Usage

The @XmlID annotation can be used with the following program elements:
  • a JavaBean property
  • non static, non transient field

See "Package Specification" in javax.xml.bind.package javadoc for additional common information.

The usage is subject to the following constraints:
  • At most one field or property in a class can be annotated with @XmlID.
  • The JavaBean property's type must be java.lang.String.
  • The only other mapping annotations that can be used with @XmlID are: @XmlElement and @XmlAttribute.

Example: Map a JavaBean property's type to xs:ID

 // Example: code fragment public class Customer { @XmlAttribute @XmlID public String getCustomerID(); public void setCustomerID(String id); .... other properties not shown } 
   <!-- Example: XML Schema fragment -->
   <xs:complexType name="Customer">
     <xs:complexContent>
       <xs:sequence>
         ....
       </xs:sequence>
       <xs:attribute name="customerID" type="xs:ID"/>
     </xs:complexContent>
   </xs:complexType>
Author:Sekhar Vajjhala, Sun Microsystems, Inc.
See Also:
Since:1.6, JAXB 2.0
/** * <p> * Maps a JavaBean property to XML ID. * * <p> * To preserve referential integrity of an object graph across XML * serialization followed by a XML deserialization, requires an object * reference to be marshalled by reference or containment * appropriately. Annotations {@code @XmlID} and {@code @XmlIDREF} * together allow a customized mapping of a JavaBean property's * type by containment or reference. * * <p><b>Usage</b> </p> * The {@code @XmlID} annotation can be used with the following * program elements: * <ul> * <li> a JavaBean property </li> * <li> non static, non transient field </li> * </ul> * * <p>See "Package Specification" in javax.xml.bind.package javadoc for * additional common information.</p> * * The usage is subject to the following constraints: * <ul> * <li> At most one field or property in a class can be annotated * with {@code @XmlID}. </li> * <li> The JavaBean property's type must be {@code java.lang.String}.</li> * <li> The only other mapping annotations that can be used * with {@code @XmlID} * are: {@code @XmlElement} and {@code @XmlAttribute}.</li> * </ul> * * <p><b>Example</b>: Map a JavaBean property's type to {@code xs:ID}</p> * <pre> * // Example: code fragment * public class Customer { * &#64;XmlAttribute * &#64;XmlID * public String getCustomerID(); * public void setCustomerID(String id); * .... other properties not shown * } * {@code * * <!-- Example: XML Schema fragment --> * <xs:complexType name="Customer"> * <xs:complexContent> * <xs:sequence> * .... * </xs:sequence> * <xs:attribute name="customerID" type="xs:ID"/> * </xs:complexContent> * </xs:complexType> * }</pre> * * @author Sekhar Vajjhala, Sun Microsystems, Inc. * @see XmlIDREF * @since 1.6, JAXB 2.0 */
@Retention(RUNTIME) @Target({FIELD, METHOD}) public @interface XmlID { }