001 /*
002 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.xml.bind.annotation;
027
028 import java.lang.annotation.Target;
029 import java.lang.annotation.Retention;
030 import static java.lang.annotation.ElementType.*;
031 import static java.lang.annotation.RetentionPolicy.*;
032
033 /**
034 * <p>
035 * Enables mapping a class to a XML Schema complex type with a
036 * simpleContent or a XML Schema simple type.
037 * </p>
038 *
039 * <p>
040 * <b> Usage: </b>
041 * <p>
042 * The <tt>@XmlValue</tt> annotation can be used with the following program
043 * elements:
044 * <ul>
045 * <li> a JavaBean property.</li>
046 * <li> non static, non transient field.</li>
047 * </ul>
048 *
049 * <p>See "Package Specification" in javax.xml.bind.package javadoc for
050 * additional common information.</p>
051 *
052 * The usage is subject to the following usage constraints:
053 * <ul>
054 * <li>At most one field or property can be annotated with the
055 * <tt>@XmlValue</tt> annotation. </li>
056 *
057 * <li><tt>@XmlValue</tt> can be used with the following
058 * annotations: {@link XmlList}. However this is redundant since
059 * {@link XmlList} maps a type to a simple schema type that derives by
060 * list just as {@link XmlValue} would. </li>
061 *
062 * <li>If the type of the field or property is a collection type,
063 * then the collection item type must map to a simple schema
064 * type. </li>
065 *
066 * <li>If the type of the field or property is not a collection
067 * type, then the type must map to a XML Schema simple type. </li>
068 *
069 * </ul>
070 * </p>
071 * <p>
072 * If the annotated JavaBean property is the sole class member being
073 * mapped to XML Schema construct, then the class is mapped to a
074 * simple type.
075 *
076 * If there are additional JavaBean properties (other than the
077 * JavaBean property annotated with <tt>@XmlValue</tt> annotation)
078 * that are mapped to XML attributes, then the class is mapped to a
079 * complex type with simpleContent.
080 * </p>
081 *
082 * <p> <b> Example 1: </b> Map a class to XML Schema simpleType</p>
083 *
084 * <pre>
085 *
086 * // Example 1: Code fragment
087 * public class USPrice {
088 * @XmlValue
089 * public java.math.BigDecimal price;
090 * }
091 *
092 * <!-- Example 1: XML Schema fragment -->
093 * <xs:simpleType name="USPrice">
094 * <xs:restriction base="xs:decimal"/>
095 * </xs:simpleType>
096 *
097 * </pre>
098 *
099 * <p><b> Example 2: </b> Map a class to XML Schema complexType with
100 * with simpleContent.</p>
101 *
102 * <pre>
103 *
104 * // Example 2: Code fragment
105 * public class InternationalPrice {
106 * @XmlValue
107 * public java.math.BigDecimal price;
108 *
109 * @XmlAttribute
110 * public String currency;
111 * }
112 *
113 * <!-- Example 2: XML Schema fragment -->
114 * <xs:complexType name="InternationalPrice">
115 * <xs:simpleContent>
116 * <xs:extension base="xs:decimal">
117 * <xs:attribute name="currency" type="xs:string"/>
118 * </xs:extension>
119 * </xs:simpleContent>
120 * </xs:complexType>
121 *
122 * </pre>
123 * </p>
124 *
125 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
126 * @see XmlType
127 * @since JAXB2.0
128 * @version $Revision: 1.5 $
129 */
130
131 @Retention(RUNTIME)
132 @Target({FIELD,METHOD})
133 public @interface XmlValue {
134 }
|