Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/XmlMixed.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/XmlMixed.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) 2005, 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.Retention; |
| aoqi@0 | 29 | import java.lang.annotation.Target; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| aoqi@0 | 32 | import static java.lang.annotation.ElementType.FIELD; |
| aoqi@0 | 33 | import static java.lang.annotation.ElementType.METHOD; |
| aoqi@0 | 34 | |
| aoqi@0 | 35 | import org.w3c.dom.Element; |
| aoqi@0 | 36 | import javax.xml.bind.JAXBElement; |
| aoqi@0 | 37 | |
| aoqi@0 | 38 | /** |
| aoqi@0 | 39 | * <p> |
| aoqi@0 | 40 | * Annotate a JavaBean multi-valued property to support mixed content. |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * <p> |
| aoqi@0 | 43 | * The usage is subject to the following constraints: |
| aoqi@0 | 44 | * <ul> |
| aoqi@0 | 45 | * <li> can be used with @XmlElementRef, @XmlElementRefs or @XmlAnyElement</li> |
| aoqi@0 | 46 | * </ul> |
| aoqi@0 | 47 | * <p> |
| aoqi@0 | 48 | * The following can be inserted into @XmlMixed annotated multi-valued property |
| aoqi@0 | 49 | * <ul> |
| aoqi@0 | 50 | * <li>XML text information items are added as values of java.lang.String.</li> |
| aoqi@0 | 51 | * <li>Children element information items are added as instances of |
| aoqi@0 | 52 | * {@link JAXBElement} or instances with a class that is annotated with |
| aoqi@0 | 53 | * @XmlRootElement.</li> |
| aoqi@0 | 54 | * <li>Unknown content that is not be bound to a JAXB mapped class is inserted |
| aoqi@0 | 55 | * as {@link Element}. (Assumes property annotated with @XmlAnyElement)</li> |
| aoqi@0 | 56 | * </ul> |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * Below is an example of binding and creation of mixed content. |
| aoqi@0 | 59 | * <pre> |
| aoqi@0 | 60 | * <!-- schema fragment having mixed content --> |
| aoqi@0 | 61 | * <xs:complexType name="letterBody" mixed="true"> |
| aoqi@0 | 62 | * <xs:sequence> |
| aoqi@0 | 63 | * <xs:element name="name" type="xs:string"/> |
| aoqi@0 | 64 | * <xs:element name="quantity" type="xs:positiveInteger"/> |
| aoqi@0 | 65 | * <xs:element name="productName" type="xs:string"/> |
| aoqi@0 | 66 | * <!-- etc. --> |
| aoqi@0 | 67 | * </xs:sequence> |
| aoqi@0 | 68 | * </xs:complexType> |
| aoqi@0 | 69 | * <xs:element name="letterBody" type="letterBody"/> |
| aoqi@0 | 70 | * |
| aoqi@0 | 71 | * // Schema-derived Java code: |
| aoqi@0 | 72 | * // (Only annotations relevant to mixed content are shown below, |
| aoqi@0 | 73 | * // others are ommitted.) |
| aoqi@0 | 74 | * import java.math.BigInteger; |
| aoqi@0 | 75 | * public class ObjectFactory { |
| aoqi@0 | 76 | * // element instance factories |
| aoqi@0 | 77 | * JAXBElement<LetterBody> createLetterBody(LetterBody value); |
| aoqi@0 | 78 | * JAXBElement<String> createLetterBodyName(String value); |
| aoqi@0 | 79 | * JAXBElement<BigInteger> createLetterBodyQuantity(BigInteger value); |
| aoqi@0 | 80 | * JAXBElement<String> createLetterBodyProductName(String value); |
| aoqi@0 | 81 | * // type instance factory |
| aoqi@0 | 82 | * LetterBody> createLetterBody(); |
| aoqi@0 | 83 | * } |
| aoqi@0 | 84 | * </pre> |
| aoqi@0 | 85 | * <pre> |
| aoqi@0 | 86 | * public class LetterBody { |
| aoqi@0 | 87 | * // Mixed content can contain instances of Element classes |
| aoqi@0 | 88 | * // Name, Quantity and ProductName. Text data is represented as |
| aoqi@0 | 89 | * // java.util.String for text. |
| aoqi@0 | 90 | * @XmlMixed |
| aoqi@0 | 91 | * @XmlElementRefs({ |
| aoqi@0 | 92 | * @XmlElementRef(name="productName", type=JAXBElement.class), |
| aoqi@0 | 93 | * @XmlElementRef(name="quantity", type=JAXBElement.class), |
| aoqi@0 | 94 | * @XmlElementRef(name="name", type=JAXBElement.class)}) |
| aoqi@0 | 95 | * List getContent(){...} |
| aoqi@0 | 96 | * } |
| aoqi@0 | 97 | * </pre> |
| aoqi@0 | 98 | * The following is an XML instance document with mixed content |
| aoqi@0 | 99 | * <pre> |
| aoqi@0 | 100 | * <letterBody> |
| aoqi@0 | 101 | * Dear Mr.<name>Robert Smith</name> |
| aoqi@0 | 102 | * Your order of <quantity>1</quantity> <productName>Baby |
| aoqi@0 | 103 | * Monitor</productName> shipped from our warehouse. .... |
| aoqi@0 | 104 | * </letterBody> |
| aoqi@0 | 105 | * </pre> |
| aoqi@0 | 106 | * that can be constructed using following JAXB API calls. |
| aoqi@0 | 107 | * <pre> |
| aoqi@0 | 108 | * LetterBody lb = ObjectFactory.createLetterBody(); |
| aoqi@0 | 109 | * JAXBElement<LetterBody> lbe = ObjectFactory.createLetterBody(lb); |
| aoqi@0 | 110 | * List gcl = lb.getContent(); //add mixed content to general content property. |
| aoqi@0 | 111 | * gcl.add("Dear Mr."); // add text information item as a String. |
| aoqi@0 | 112 | * |
| aoqi@0 | 113 | * // add child element information item |
| aoqi@0 | 114 | * gcl.add(ObjectFactory.createLetterBodyName("Robert Smith")); |
| aoqi@0 | 115 | * gcl.add("Your order of "); // add text information item as a String |
| aoqi@0 | 116 | * |
| aoqi@0 | 117 | * // add children element information items |
| aoqi@0 | 118 | * gcl.add(ObjectFactory. |
| aoqi@0 | 119 | * createLetterBodyQuantity(new BigInteger("1"))); |
| aoqi@0 | 120 | * gcl.add(ObjectFactory.createLetterBodyProductName("Baby Monitor")); |
| aoqi@0 | 121 | * gcl.add("shipped from our warehouse"); // add text information item |
| aoqi@0 | 122 | * </pre> |
| aoqi@0 | 123 | * |
| aoqi@0 | 124 | * <p>See "Package Specification" in javax.xml.bind.package javadoc for |
| aoqi@0 | 125 | * additional common information.</p> |
| aoqi@0 | 126 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 127 | * @since JAXB2.0 |
| aoqi@0 | 128 | */ |
| aoqi@0 | 129 | @Retention(RUNTIME) |
| aoqi@0 | 130 | @Target({FIELD,METHOD}) |
| aoqi@0 | 131 | public @interface XmlMixed { |
| aoqi@0 | 132 | } |
