ohair@286: /*
ohair@286:  * Copyright (c) 2004, 2010, 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 java.lang.annotation.Target;
ohair@286: import java.lang.annotation.Retention;
ohair@286: import static java.lang.annotation.ElementType.*;
ohair@286: import static java.lang.annotation.RetentionPolicy.*;
ohair@286: 
ohair@286: /**
ohair@286:  * <p>
ohair@286:  * Enables mapping a class to a  XML Schema complex type with a
ohair@286:  * simpleContent or a XML Schema simple type.
ohair@286:  * </p>
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * <b> Usage: </b>
ohair@286:  * <p>
ohair@286:  * The <tt>@XmlValue</tt> annotation can be used with the following program
ohair@286:  * elements:
ohair@286:  * <ul>
ohair@286:  *   <li> a JavaBean property.</li>
ohair@286:  *   <li> non static, non transient field.</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:  * The usage is subject to the following usage constraints:
ohair@286:  * <ul>
ohair@286:  *   <li>At most one field or property can be annotated with the
ohair@286:  *       <tt>@XmlValue</tt> annotation. </li>
ohair@286:  *
ohair@286:  *   <li><tt>@XmlValue</tt> can be used with the following
ohair@286:  *   annotations: {@link XmlList}. However this is redundant since
ohair@286:  *   {@link XmlList} maps a type to a simple schema type that derives by
ohair@286:  *   list just as {@link XmlValue} would. </li>
ohair@286:  *
ohair@286:  *   <li>If the type of the field or property is a collection type,
ohair@286:  *       then the collection item type must map to a simple schema
ohair@286:  *       type.  </li>
ohair@286:  *
ohair@286:  *   <li>If the type of the field or property is not a collection
ohair@286:  *       type, then the type must map to a XML Schema simple type. </li>
ohair@286:  *
ohair@286:  * </ul>
ohair@286:  * </p>
ohair@286:  * <p>
ohair@286:  * If the annotated JavaBean property is the sole class member being
ohair@286:  * mapped to XML Schema construct, then the class is mapped to a
ohair@286:  * simple type.
ohair@286:  *
ohair@286:  * If there are additional JavaBean properties (other than the
ohair@286:  * JavaBean property annotated with <tt>@XmlValue</tt> annotation)
ohair@286:  * that are mapped to XML attributes, then the class is mapped to a
ohair@286:  * complex type with simpleContent.
ohair@286:  * </p>
ohair@286:  *
ohair@286:  * <p> <b> Example 1: </b> Map a class to XML Schema simpleType</p>
ohair@286:  *
ohair@286:  *   <pre>
ohair@286:  *
ohair@286:  *     // Example 1: Code fragment
ohair@286:  *     public class USPrice {
ohair@286:  *         &#64;XmlValue
ohair@286:  *         public java.math.BigDecimal price;
ohair@286:  *     }
ohair@286:  *
ohair@286:  *     &lt;!-- Example 1: XML Schema fragment -->
ohair@286:  *     &lt;xs:simpleType name="USPrice">
ohair@286:  *       &lt;xs:restriction base="xs:decimal"/>
ohair@286:  *     &lt;/xs:simpleType>
ohair@286:  *
ohair@286:  *   </pre>
ohair@286:  *
ohair@286:  * <p><b> Example 2: </b> Map a class to XML Schema complexType with
ohair@286:  *        with simpleContent.</p>
ohair@286:  *
ohair@286:  *   <pre>
ohair@286:  *
ohair@286:  *   // Example 2: Code fragment
ohair@286:  *   public class InternationalPrice {
ohair@286:  *       &#64;XmlValue
ohair@286:  *       public java.math.BigDecimal price;
ohair@286:  *
ohair@286:  *       &#64;XmlAttribute
ohair@286:  *       public String currency;
ohair@286:  *   }
ohair@286:  *
ohair@286:  *   &lt;!-- Example 2: XML Schema fragment -->
ohair@286:  *   &lt;xs:complexType name="InternationalPrice">
ohair@286:  *     &lt;xs:simpleContent>
ohair@286:  *       &lt;xs:extension base="xs:decimal">
ohair@286:  *         &lt;xs:attribute name="currency" type="xs:string"/>
ohair@286:  *       &lt;/xs:extension>
ohair@286:  *     &lt;/xs:simpleContent>
ohair@286:  *   &lt;/xs:complexType>
ohair@286:  *
ohair@286:  *   </pre>
ohair@286:  * </p>
ohair@286:  *
ohair@286:  * @author Sekhar Vajjhala, Sun Microsystems, Inc.
ohair@286:  * @see XmlType
ohair@286:  * @since JAXB2.0
ohair@286:  */
ohair@286: 
ohair@286: @Retention(RUNTIME) @Target({FIELD, METHOD})
ohair@286: public @interface XmlValue {}