aoqi@0: /* aoqi@0: * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package javax.xml.bind.annotation; aoqi@0: aoqi@0: import java.lang.annotation.Retention; aoqi@0: import java.lang.annotation.Target; aoqi@0: aoqi@0: import static java.lang.annotation.RetentionPolicy.RUNTIME; aoqi@0: import static java.lang.annotation.ElementType.FIELD; aoqi@0: import static java.lang.annotation.ElementType.METHOD; aoqi@0: aoqi@0: import org.w3c.dom.Element; aoqi@0: import javax.xml.bind.JAXBElement; aoqi@0: aoqi@0: /** aoqi@0: *
aoqi@0: * Annotate a JavaBean multi-valued property to support mixed content. aoqi@0: * aoqi@0: *
aoqi@0: * The usage is subject to the following constraints: aoqi@0: *
aoqi@0: * The following can be inserted into @XmlMixed annotated multi-valued property aoqi@0: *
aoqi@0: * <!-- schema fragment having mixed content --> aoqi@0: * <xs:complexType name="letterBody" mixed="true"> aoqi@0: * <xs:sequence> aoqi@0: * <xs:element name="name" type="xs:string"/> aoqi@0: * <xs:element name="quantity" type="xs:positiveInteger"/> aoqi@0: * <xs:element name="productName" type="xs:string"/> aoqi@0: * <!-- etc. --> aoqi@0: * </xs:sequence> aoqi@0: * </xs:complexType> aoqi@0: * <xs:element name="letterBody" type="letterBody"/> aoqi@0: * aoqi@0: * // Schema-derived Java code: aoqi@0: * // (Only annotations relevant to mixed content are shown below, aoqi@0: * // others are ommitted.) aoqi@0: * import java.math.BigInteger; aoqi@0: * public class ObjectFactory { aoqi@0: * // element instance factories aoqi@0: * JAXBElement<LetterBody> createLetterBody(LetterBody value); aoqi@0: * JAXBElement<String> createLetterBodyName(String value); aoqi@0: * JAXBElement<BigInteger> createLetterBodyQuantity(BigInteger value); aoqi@0: * JAXBElement<String> createLetterBodyProductName(String value); aoqi@0: * // type instance factory aoqi@0: * LetterBody> createLetterBody(); aoqi@0: * } aoqi@0: *aoqi@0: *
aoqi@0: * public class LetterBody { aoqi@0: * // Mixed content can contain instances of Element classes aoqi@0: * // Name, Quantity and ProductName. Text data is represented as aoqi@0: * // java.util.String for text. aoqi@0: * @XmlMixed aoqi@0: * @XmlElementRefs({ aoqi@0: * @XmlElementRef(name="productName", type=JAXBElement.class), aoqi@0: * @XmlElementRef(name="quantity", type=JAXBElement.class), aoqi@0: * @XmlElementRef(name="name", type=JAXBElement.class)}) aoqi@0: * List getContent(){...} aoqi@0: * } aoqi@0: *aoqi@0: * The following is an XML instance document with mixed content aoqi@0: *
aoqi@0: * <letterBody> aoqi@0: * Dear Mr.<name>Robert Smith</name> aoqi@0: * Your order of <quantity>1</quantity> <productName>Baby aoqi@0: * Monitor</productName> shipped from our warehouse. .... aoqi@0: * </letterBody> aoqi@0: *aoqi@0: * that can be constructed using following JAXB API calls. aoqi@0: *
aoqi@0: * LetterBody lb = ObjectFactory.createLetterBody(); aoqi@0: * JAXBElement<LetterBody> lbe = ObjectFactory.createLetterBody(lb); aoqi@0: * List gcl = lb.getContent(); //add mixed content to general content property. aoqi@0: * gcl.add("Dear Mr."); // add text information item as a String. aoqi@0: * aoqi@0: * // add child element information item aoqi@0: * gcl.add(ObjectFactory.createLetterBodyName("Robert Smith")); aoqi@0: * gcl.add("Your order of "); // add text information item as a String aoqi@0: * aoqi@0: * // add children element information items aoqi@0: * gcl.add(ObjectFactory. aoqi@0: * createLetterBodyQuantity(new BigInteger("1"))); aoqi@0: * gcl.add(ObjectFactory.createLetterBodyProductName("Baby Monitor")); aoqi@0: * gcl.add("shipped from our warehouse"); // add text information item aoqi@0: *aoqi@0: * aoqi@0: *
See "Package Specification" in javax.xml.bind.package javadoc for aoqi@0: * additional common information.
aoqi@0: * @author Kohsuke Kawaguchi aoqi@0: * @since JAXB2.0 aoqi@0: */ aoqi@0: @Retention(RUNTIME) aoqi@0: @Target({FIELD,METHOD}) aoqi@0: public @interface XmlMixed { aoqi@0: }