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