src/share/jaxws_classes/javax/xml/bind/annotation/XmlValue.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind.annotation;
ohair@286 27
ohair@286 28 import java.lang.annotation.Target;
ohair@286 29 import java.lang.annotation.Retention;
ohair@286 30 import static java.lang.annotation.ElementType.*;
ohair@286 31 import static java.lang.annotation.RetentionPolicy.*;
ohair@286 32
ohair@286 33 /**
ohair@286 34 * <p>
ohair@286 35 * Enables mapping a class to a XML Schema complex type with a
ohair@286 36 * simpleContent or a XML Schema simple type.
ohair@286 37 * </p>
ohair@286 38 *
ohair@286 39 * <p>
ohair@286 40 * <b> Usage: </b>
ohair@286 41 * <p>
ohair@286 42 * The <tt>@XmlValue</tt> annotation can be used with the following program
ohair@286 43 * elements:
ohair@286 44 * <ul>
ohair@286 45 * <li> a JavaBean property.</li>
ohair@286 46 * <li> non static, non transient field.</li>
ohair@286 47 * </ul>
ohair@286 48 *
ohair@286 49 * <p>See "Package Specification" in javax.xml.bind.package javadoc for
ohair@286 50 * additional common information.</p>
ohair@286 51 *
ohair@286 52 * The usage is subject to the following usage constraints:
ohair@286 53 * <ul>
ohair@286 54 * <li>At most one field or property can be annotated with the
ohair@286 55 * <tt>@XmlValue</tt> annotation. </li>
ohair@286 56 *
ohair@286 57 * <li><tt>@XmlValue</tt> can be used with the following
ohair@286 58 * annotations: {@link XmlList}. However this is redundant since
ohair@286 59 * {@link XmlList} maps a type to a simple schema type that derives by
ohair@286 60 * list just as {@link XmlValue} would. </li>
ohair@286 61 *
ohair@286 62 * <li>If the type of the field or property is a collection type,
ohair@286 63 * then the collection item type must map to a simple schema
ohair@286 64 * type. </li>
ohair@286 65 *
ohair@286 66 * <li>If the type of the field or property is not a collection
ohair@286 67 * type, then the type must map to a XML Schema simple type. </li>
ohair@286 68 *
ohair@286 69 * </ul>
ohair@286 70 * </p>
ohair@286 71 * <p>
ohair@286 72 * If the annotated JavaBean property is the sole class member being
ohair@286 73 * mapped to XML Schema construct, then the class is mapped to a
ohair@286 74 * simple type.
ohair@286 75 *
ohair@286 76 * If there are additional JavaBean properties (other than the
ohair@286 77 * JavaBean property annotated with <tt>@XmlValue</tt> annotation)
ohair@286 78 * that are mapped to XML attributes, then the class is mapped to a
ohair@286 79 * complex type with simpleContent.
ohair@286 80 * </p>
ohair@286 81 *
ohair@286 82 * <p> <b> Example 1: </b> Map a class to XML Schema simpleType</p>
ohair@286 83 *
ohair@286 84 * <pre>
ohair@286 85 *
ohair@286 86 * // Example 1: Code fragment
ohair@286 87 * public class USPrice {
ohair@286 88 * &#64;XmlValue
ohair@286 89 * public java.math.BigDecimal price;
ohair@286 90 * }
ohair@286 91 *
ohair@286 92 * &lt;!-- Example 1: XML Schema fragment -->
ohair@286 93 * &lt;xs:simpleType name="USPrice">
ohair@286 94 * &lt;xs:restriction base="xs:decimal"/>
ohair@286 95 * &lt;/xs:simpleType>
ohair@286 96 *
ohair@286 97 * </pre>
ohair@286 98 *
ohair@286 99 * <p><b> Example 2: </b> Map a class to XML Schema complexType with
ohair@286 100 * with simpleContent.</p>
ohair@286 101 *
ohair@286 102 * <pre>
ohair@286 103 *
ohair@286 104 * // Example 2: Code fragment
ohair@286 105 * public class InternationalPrice {
ohair@286 106 * &#64;XmlValue
ohair@286 107 * public java.math.BigDecimal price;
ohair@286 108 *
ohair@286 109 * &#64;XmlAttribute
ohair@286 110 * public String currency;
ohair@286 111 * }
ohair@286 112 *
ohair@286 113 * &lt;!-- Example 2: XML Schema fragment -->
ohair@286 114 * &lt;xs:complexType name="InternationalPrice">
ohair@286 115 * &lt;xs:simpleContent>
ohair@286 116 * &lt;xs:extension base="xs:decimal">
ohair@286 117 * &lt;xs:attribute name="currency" type="xs:string"/>
ohair@286 118 * &lt;/xs:extension>
ohair@286 119 * &lt;/xs:simpleContent>
ohair@286 120 * &lt;/xs:complexType>
ohair@286 121 *
ohair@286 122 * </pre>
ohair@286 123 * </p>
ohair@286 124 *
ohair@286 125 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
ohair@286 126 * @see XmlType
ohair@286 127 * @since JAXB2.0
ohair@286 128 */
ohair@286 129
ohair@286 130 @Retention(RUNTIME) @Target({FIELD, METHOD})
ohair@286 131 public @interface XmlValue {}

mercurial