Java EE 5 SDK

Annotation Type XmlID

public @interface XmlID

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.


The @XmlID annotation can be used with the following program elements:

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

The usage is subject to the following constraints:

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

    // Example: code fragment
    public class Customer {
        public String getCustomerID();
        public void setCustomerID(String id);
        .... other properties not shown 

    <!-- Example: XML Schema fragment -->
    <xs:complexType name="Customer">
        <xs:attribute name="customerID" type="xs:ID"/>

$Revision: 1.5 $
Sekhar Vajjhala, Sun Microsystems, Inc.
See Also:

Java EE 5 SDK

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.

Scripting on this page tracks web page traffic, but does not change the content in any way.