ohair@286: /*
ohair@286:  * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.xml.bind.annotation;
ohair@286: 
ohair@286: import static java.lang.annotation.ElementType.TYPE;
ohair@286: import java.lang.annotation.Retention;
ohair@286: import static java.lang.annotation.RetentionPolicy.RUNTIME;
ohair@286: import java.lang.annotation.Target;
ohair@286: 
ohair@286: /**
ohair@286:  * <p>
ohair@286:  * Maps a class or an enum type to a XML Schema type.
ohair@286:  *
ohair@286:  * <p><b>Usage</b></p>
ohair@286:  * <p> The <tt>@XmlType</tt> annnotation can be used with the following program
ohair@286:  * elements:
ohair@286:  * <ul>
ohair@286:  *   <li> a top level class </li>
ohair@286:  *   <li> an enum type </li>
ohair@286:  * </ul>
ohair@286:  *
ohair@286:  * <p>See "Package Specification" in javax.xml.bind.package javadoc for
ohair@286:  * additional common information.</p>
ohair@286:  *
ohair@286:  * <h3> Mapping a Class </h3>
ohair@286:  * <p>
ohair@286:  * A class maps to a XML Schema type. A class is a data container for
ohair@286:  * values represented by properties and fields. A schema type is a
ohair@286:  * data container for values represented by schema components within a
ohair@286:  * schema type's content model (e.g. model groups, attributes etc).
ohair@286:  * <p> To be mapped, a class must either have a public no-arg
ohair@286:  * constructor or a static no-arg factory method. The static factory
ohair@286:  * method can be specified in <tt>factoryMethod()</tt> and
ohair@286:  * <tt>factoryClass()</tt> annotation elements. The static factory
ohair@286:  * method or the no-arg constructor is used during unmarshalling to
ohair@286:  * create an instance of this class. If both are present, the static
ohair@286:  * factory method overrides the no-arg constructor.
ohair@286:  * <p>
ohair@286:  * A class maps to either a XML Schema complex type or a XML Schema simple
ohair@286:  * type. The XML Schema type is derived based on the
ohair@286:  * mapping of JavaBean properties and fields contained within the
ohair@286:  * class. The schema type to which the class is mapped can either be
ohair@286:  * named or anonymous. A class can be mapped to an anonymous schema
ohair@286:  * type by annotating the class with <tt>&#64XmlType(name="")</tt>.
ohair@286:  * <p>
ohair@286:  * Either a global element, local element or a local attribute can be
ohair@286:  * associated with an anonymous type as follows:
ohair@286:  * <ul>
ohair@286:  *   <li><b>global element: </b> A global element of an anonymous
ohair@286:  *      type can be derived by annotating the class with @{@link
ohair@286:  *      XmlRootElement}. See Example 3 below. </li>
ohair@286:  *
ohair@286:  *   <li><b>local element: </b> A JavaBean property that references
ohair@286:  *      a class annotated with @XmlType(name="") and is mapped to the
ohair@286:  *      element associated with the anonymous type. See Example 4
ohair@286:  *      below.</li>
ohair@286:  *
ohair@286:  *   <li><b>attribute: </b> A JavaBean property that references
ohair@286:  *      a class annotated with @XmlType(name="") and is mapped to the
ohair@286:  *      attribute associated with the anonymous type. See Example 5 below. </li>
ohair@286:  * </ul>
ohair@286:  * <b> Mapping to XML Schema Complex Type </b>
ohair@286:  * <ul>
ohair@286:  *   <li>If class is annotated with <tt>@XmlType(name="") </tt>, it
ohair@286:  *   is mapped to an anonymous type otherwise, the class name maps
ohair@286:  *   to a complex type name. The <tt>XmlName()</tt> annotation element
ohair@286:  *   can be used to customize the name.</li>
ohair@286:  *
ohair@286:  *   <li> Properties and fields that are mapped to elements are mapped to a
ohair@286:  *   content model within a complex type. The annotation element
ohair@286:  *   <tt>propOrder()</tt> can be used to customize the content model to be
ohair@286:  *   <tt>xs:all</tt> or <tt>xs:sequence</tt>.  It is used for specifying
ohair@286:  *   the order of XML elements in <tt>xs:sequence</tt>. </li>
ohair@286:  *
ohair@286:  *   <li> Properties and fields can be mapped to attributes within the
ohair@286:  *        complex type.  </li>
ohair@286:  *
ohair@286:  *   <li> The targetnamespace of the XML Schema type can be customized
ohair@286:  *        using the annotation element <tt>namespace()</tt>. </li>
ohair@286:  * </ul>
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * <b> Mapping class to XML Schema simple type </b>
ohair@286:  * <p>
ohair@286:  * A class can be mapped to a XML Schema simple type using the
ohair@286:  * <tt>@XmlValue</tt> annotation. For additional details and examples,
ohair@286:  * see @{@link XmlValue} annotation type.
ohair@286:  * <p>
ohair@286:  * The following table shows the mapping of the class to a XML Schema
ohair@286:  * complex type or simple type. The notational symbols used in the table are:
ohair@286:  * <ul>
ohair@286:  *   <li> ->    : represents a mapping </li>
ohair@286:  *   <li> [x]+  : one or more occurances of x </li>
ohair@286:  *   <li> [ <tt>@XmlValue</tt> property ]: JavaBean property annotated with
ohair@286:  *         <tt>@XmlValue</tt></li>
ohair@286:  *   <li> X     : don't care
ohair@286:  * </ul>
ohair@286:  * <blockquote>
ohair@286:  *   <table border="1" cellpadding="4" cellspacing="3">
ohair@286:  *     <tbody>
ohair@286:  *       <tr>
ohair@286:  *         <td><b>Target</b></td>
ohair@286:  *         <td><b>propOrder</b></td>
ohair@286:  *         <td><b>ClassBody</b></td>
ohair@286:  *         <td><b>ComplexType</b></td>
ohair@286:  *         <td><b>SimpleType</b></td>
ohair@286:  *       </tr>
ohair@286:  *
ohair@286:  *       <tr valign="top">
ohair@286:  *         <td>Class</td>
ohair@286:  *         <td>{}</td>
ohair@286:  *         <td>[property]+ -> elements</td>
ohair@286:  *         <td>complexcontent<br>xs:all</td>
ohair@286:  *         <td> </td>
ohair@286:  *       </tr>
ohair@286:  *
ohair@286:  *       <tr valign="top">
ohair@286:  *         <td>Class</td>
ohair@286:  *         <td>non empty</td>
ohair@286:  *         <td>[property]+ -> elements</td>
ohair@286:  *         <td>complexcontent<br>xs:sequence</td>
ohair@286:  *         <td> </td>
ohair@286:  *       </tr>
ohair@286:  *
ohair@286:  *       <tr valign="top">
ohair@286:  *         <td>Class</td>
ohair@286:  *         <td>X</td>
ohair@286:  *         <td>no property -> element</td>
ohair@286:  *         <td>complexcontent<br>empty sequence</td>
ohair@286:  *         <td> </td>
ohair@286:  *       </tr>
ohair@286:  *
ohair@286:  *       <tr valign="top">
ohair@286:  *         <td>Class</td>
ohair@286:  *         <td>X</td>
ohair@286:  *         <td>1 [ <tt>@XmlValue</tt> property] && <br> [property]+
ohair@286:  *             ->attributes</td>
ohair@286:  *         <td>simplecontent</td>
ohair@286:  *         <td> </td>
ohair@286:  *       </tr>
ohair@286:  *
ohair@286:  *       <tr valign="top">
ohair@286:  *         <td>Class</td>
ohair@286:  *         <td>X</td>
ohair@286:  *         <td>1 [ <tt>@XmlValue</tt> property ]&& <br> no properties
ohair@286:  *         -> attribute</td>
ohair@286:  *         <td> </td>
ohair@286:  *         <td>simpletype</td>
ohair@286:  *         <td> </td>
ohair@286:  *       </tr>
ohair@286:  *     </tbody>
ohair@286:  *   </table>
ohair@286:  * </blockquote>
ohair@286:  *
ohair@286:  * <h3> Mapping an enum type </h3>
ohair@286:  *
ohair@286:  * An enum type maps to a XML schema simple type with enumeration
ohair@286:  * facets. The following annotation elements are ignored since they
ohair@286:  * are not meaningful: <tt>propOrder()</tt> , <tt>factoryMethod()</tt> ,
ohair@286:  * <tt>factoryClass()</tt> .
ohair@286:  *
ohair@286:  *  <h3> Usage with other annotations </h3>
ohair@286:  * <p> This annotation can be used with the following annotations:
ohair@286:  * {@link XmlRootElement}, {@link XmlAccessorOrder}, {@link XmlAccessorType},
ohair@286:  * {@link XmlEnum}. However, {@link
ohair@286:  * XmlAccessorOrder} and {@link XmlAccessorType} are ignored when this
ohair@286:  * annotation is used on an enum type.
ohair@286:  *
ohair@286:  * <p> <b> Example 1: </b> Map a class to a complex type with
ohair@286:  *   xs:sequence with a customized ordering of JavaBean properties.
ohair@286:  * </p>
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  *   &#64;XmlType(propOrder={"street", "city" , "state", "zip", "name" })
ohair@286:  *   public class USAddress {
ohair@286:  *     String getName() {..};
ohair@286:  *     void setName(String) {..};
ohair@286:  *
ohair@286:  *     String getStreet() {..};
ohair@286:  *     void setStreet(String) {..};
ohair@286:  *
ohair@286:  *     String getCity() {..};
ohair@286:  *     void setCity(String) {..};
ohair@286:  *
ohair@286:  *     String getState() {..};
ohair@286:  *     void setState(String) {..};
ohair@286:  *
ohair@286:  *     java.math.BigDecimal getZip() {..};
ohair@286:  *     void setZip(java.math.BigDecimal) {..};
ohair@286:  *   }
ohair@286:  *
ohair@286:  *   &lt;!-- XML Schema mapping for USAddress -->
ohair@286:  *   &lt;xs:complexType name="USAddress">
ohair@286:  *     &lt;xs:sequence>
ohair@286:  *       &lt;xs:element name="street" type="xs:string"/>
ohair@286:  *       &lt;xs:element name="city" type="xs:string"/>
ohair@286:  *       &lt;xs:element name="state" type="xs:string"/>
ohair@286:  *       &lt;xs:element name="zip" type="xs:decimal"/>
ohair@286:  *       &lt;xs:element name="name" type="xs:string"/>
ohair@286:  *     &lt;/xs:all>
ohair@286:  *   &lt;/xs:complexType>
ohair@286:  * </pre>
ohair@286:  * <p> <b> Example 2: </b> Map a class to a complex type with
ohair@286:  *     xs:all </p>
ohair@286:  * <pre>
ohair@286:  * &#64;XmlType(propOrder={})
ohair@286:  * public class USAddress { ...}
ohair@286:  *
ohair@286:  * &lt;!-- XML Schema mapping for USAddress -->
ohair@286:  * &lt;xs:complexType name="USAddress">
ohair@286:  *   &lt;xs:all>
ohair@286:  *     &lt;xs:element name="name" type="xs:string"/>
ohair@286:  *     &lt;xs:element name="street" type="xs:string"/>
ohair@286:  *     &lt;xs:element name="city" type="xs:string"/>
ohair@286:  *     &lt;xs:element name="state" type="xs:string"/>
ohair@286:  *     &lt;xs:element name="zip" type="xs:decimal"/>
ohair@286:  *   &lt;/xs:sequence>
ohair@286:  * &lt;/xs:complexType>
ohair@286:  *</pre>
ohair@286:  * <p> <b> Example 3: </b> Map a class to a global element with an
ohair@286:  * anonymous type.
ohair@286:  * </p>
ohair@286:  * <pre>
ohair@286:  *   &#64;XmlRootElement
ohair@286:  *   &#64;XmlType(name="")
ohair@286:  *   public class USAddress { ...}
ohair@286:  *
ohair@286:  *   &lt;!-- XML Schema mapping for USAddress -->
ohair@286:  *   &lt;xs:element name="USAddress">
ohair@286:  *     &lt;xs:complexType>
ohair@286:  *       &lt;xs:sequence>
ohair@286:  *         &lt;xs:element name="name" type="xs:string"/>
ohair@286:  *         &lt;xs:element name="street" type="xs:string"/>
ohair@286:  *         &lt;xs:element name="city" type="xs:string"/>
ohair@286:  *         &lt;xs:element name="state" type="xs:string"/>
ohair@286:  *         &lt;xs:element name="zip" type="xs:decimal"/>
ohair@286:  *       &lt;/xs:sequence>
ohair@286:  *     &lt;/xs:complexType>
ohair@286:  *   &lt;/xs:element>
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * <p> <b> Example 4: </b> Map a property to a local element with
ohair@286:  * anonmyous type.
ohair@286:  * <pre>
ohair@286:  *   //Example: Code fragment
ohair@286:  *   public class Invoice {
ohair@286:  *       USAddress addr;
ohair@286:  *           ...
ohair@286:  *       }
ohair@286:  *
ohair@286:  *   &#64;XmlType(name="")
ohair@286:  *   public class USAddress { ... }
ohair@286:  *   }
ohair@286:  *
ohair@286:  *   &lt;!-- XML Schema mapping for USAddress -->
ohair@286:  *   &lt;xs:complexType name="Invoice">
ohair@286:  *     &lt;xs:sequence>
ohair@286:  *       &lt;xs:element name="addr">
ohair@286:  *         &lt;xs:complexType>
ohair@286:  *           &lt;xs:element name="name", type="xs:string"/>
ohair@286:  *           &lt;xs:element name="city", type="xs:string"/>
ohair@286:  *           &lt;xs:element name="city" type="xs:string"/>
ohair@286:  *           &lt;xs:element name="state" type="xs:string"/>
ohair@286:  *           &lt;xs:element name="zip" type="xs:decimal"/>
ohair@286:  *         &lt;/xs:complexType>
ohair@286:  *       ...
ohair@286:  *     &lt;/xs:sequence>
ohair@286:  *   &lt;/xs:complexType>
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * <p> <b> Example 5: </b> Map a property to an attribute with
ohair@286:  * anonymous type.
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  *
ohair@286:  *     //Example: Code fragment
ohair@286:  *     public class Item {
ohair@286:  *         public String name;
ohair@286:  *         &#64;XmlAttribute
ohair@286:  *         public USPrice price;
ohair@286:  *     }
ohair@286:  *
ohair@286:  *     // map class to anonymous simple type.
ohair@286:  *     &#64;XmlType(name="")
ohair@286:  *     public class USPrice {
ohair@286:  *         &#64;XmlValue
ohair@286:  *         public java.math.BigDecimal price;
ohair@286:  *     }
ohair@286:  *
ohair@286:  *     &lt;!-- Example: XML Schema fragment -->
ohair@286:  *     &lt;xs:complexType name="Item">
ohair@286:  *       &lt;xs:sequence>
ohair@286:  *         &lt;xs:element name="name" type="xs:string"/>
ohair@286:  *         &lt;xs:attribute name="price">
ohair@286:  *           &lt;xs:simpleType>
ohair@286:  *             &lt;xs:restriction base="xs:decimal"/>
ohair@286:  *           &lt;/xs:simpleType>
ohair@286:  *         &lt;/xs:attribute>
ohair@286:  *       &lt;/xs:sequence>
ohair@286:  *     &lt;/xs:complexType>
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  *  <p> <b> Example 6: </b> Define a factoryClass and factoryMethod
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  *      &#64;XmlType(name="USAddressType", factoryClass=USAddressFactory.class,
ohair@286:  *      factoryMethod="getUSAddress")
ohair@286:  *      public class USAddress {
ohair@286:  *
ohair@286:  *          private String city;
ohair@286:  *          private String name;
ohair@286:  *          private String state;
ohair@286:  *          private String street;
ohair@286:  *          private int    zip;
ohair@286:  *
ohair@286:  *      public USAddress(String name, String street, String city,
ohair@286:  *          String state, int zip) {
ohair@286:  *          this.name = name;
ohair@286:  *          this.street = street;
ohair@286:  *          this.city = city;
ohair@286:  *          this.state = state;
ohair@286:  *          this.zip = zip;
ohair@286:  *      }
ohair@286:  *  }
ohair@286:  *
ohair@286:  *  public class USAddressFactory {
ohair@286:  *      public static USAddress getUSAddress(){
ohair@286:  *       return new USAddress("Mark Baker", "23 Elm St",
ohair@286:  *          "Dayton", "OH", 90952);
ohair@286:  *  }
ohair@286:  *
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  *  <p> <b> Example 7: </b> Define factoryMethod and use the default factoryClass
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  *      &#64;XmlType(name="USAddressType", factoryMethod="getNewInstance")
ohair@286:  *      public class USAddress {
ohair@286:  *
ohair@286:  *          private String city;
ohair@286:  *          private String name;
ohair@286:  *          private String state;
ohair@286:  *          private String street;
ohair@286:  *          private int    zip;
ohair@286:  *
ohair@286:  *          private USAddress() {}
ohair@286:  *
ohair@286:  *          public static USAddress getNewInstance(){
ohair@286:  *              return new USAddress();
ohair@286:  *          }
ohair@286:  *      }
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * @author Sekhar Vajjhala, Sun Microsystems, Inc.
ohair@286:  * @see XmlElement
ohair@286:  * @see XmlAttribute
ohair@286:  * @see XmlValue
ohair@286:  * @see XmlSchema
ohair@286:  * @since JAXB2.0
ohair@286:  */
ohair@286: 
ohair@286: @Retention(RUNTIME) @Target({TYPE})
ohair@286: public @interface XmlType {
ohair@286:     /**
ohair@286:      * Name of the XML Schema type which the class is mapped.
ohair@286:      */
ohair@286:     String name() default "##default" ;
ohair@286: 
ohair@286:     /**
ohair@286:      * Specifies the order for XML Schema elements when class is
ohair@286:      * mapped to a XML Schema complex type.
ohair@286:      *
ohair@286:      * <p> Refer to the table for how the propOrder affects the
ohair@286:      * mapping of class </p>
ohair@286:      *
ohair@286:      * <p> The propOrder is a list of names of JavaBean properties in
ohair@286:      *     the class. Each name in the list is the name of a Java
ohair@286:      *     identifier of the JavaBean property. The order in which
ohair@286:      *     JavaBean properties are listed is the order of XML Schema
ohair@286:      *     elements to which the JavaBean properties are mapped. </p>
ohair@286:      * <p> All of the JavaBean properties being mapped to XML Schema elements
ohair@286:      *     must be listed.
ohair@286:      * <p> A JavaBean property or field listed in propOrder must not
ohair@286:      *     be transient or annotated with <tt>@XmlTransient</tt>.
ohair@286:      * <p> The default ordering of JavaBean properties is determined
ohair@286:      *     by @{@link XmlAccessorOrder}.
ohair@286:      */
ohair@286:     String[] propOrder() default {""};
ohair@286: 
ohair@286:     /**
ohair@286:      * Name of the target namespace of the XML Schema type. By
ohair@286:      * default, this is the target namespace to which the package
ohair@286:      * containing the class is mapped.
ohair@286:      */
ohair@286:     String namespace() default "##default" ;
ohair@286: 
ohair@286:     /**
ohair@286:      * Class containing a no-arg factory method for creating an
ohair@286:      * instance of this class. The default is this class.
ohair@286:      *
ohair@286:      * <p>If <tt>factoryClass</tt> is DEFAULT.class and
ohair@286:      * <tt>factoryMethod</tt> is "", then there is no static factory
ohair@286:      * method.
ohair@286:      *
ohair@286:      * <p>If <tt>factoryClass</tt> is DEFAULT.class and
ohair@286:      * <tt>factoryMethod</tt> is not "", then
ohair@286:      * <tt>factoryMethod</tt> is the name of a static factory method
ohair@286:      * in this class.
ohair@286:      *
ohair@286:      * <p>If <tt>factoryClass</tt> is not DEFAULT.class, then
ohair@286:      * <tt>factoryMethod</tt> must not be "" and must be the name of
ohair@286:      * a static factory method specified in <tt>factoryClass</tt>.
ohair@286:      */
ohair@286:     Class factoryClass() default DEFAULT.class;
ohair@286: 
ohair@286:     /**
ohair@286:      * Used in {@link XmlType#factoryClass()} to
ohair@286:      * signal that either factory mehod is not used or
ohair@286:      * that it's in the class with this {@link XmlType} itself.
ohair@286:      */
ohair@286:     static final class DEFAULT {}
ohair@286: 
ohair@286:     /**
ohair@286:      * Name of a no-arg factory method in the class specified in
ohair@286:      * <tt>factoryClass</tt> factoryClass().
ohair@286:      *
ohair@286:      */
ohair@286:     String factoryMethod() default "";
ohair@286: }