ohair@286: /* ohair@286: * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. ohair@286: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. ohair@286: * ohair@286: * This code is free software; you can redistribute it and/or modify it ohair@286: * under the terms of the GNU General Public License version 2 only, as ohair@286: * published by the Free Software Foundation. Oracle designates this ohair@286: * particular file as subject to the "Classpath" exception as provided ohair@286: * by Oracle in the LICENSE file that accompanied this code. ohair@286: * ohair@286: * This code is distributed in the hope that it will be useful, but WITHOUT ohair@286: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or ohair@286: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License ohair@286: * version 2 for more details (a copy is included in the LICENSE file that ohair@286: * accompanied this code). ohair@286: * ohair@286: * You should have received a copy of the GNU General Public License version ohair@286: * 2 along with this work; if not, write to the Free Software Foundation, ohair@286: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. ohair@286: * ohair@286: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@286: * or visit www.oracle.com if you need additional information or have any ohair@286: * questions. ohair@286: */ ohair@286: ohair@286: package javax.xml.bind.annotation; ohair@286: ohair@286: import java.lang.annotation.Retention; ohair@286: import java.lang.annotation.Target; ohair@286: ohair@286: import static java.lang.annotation.RetentionPolicy.RUNTIME; ohair@286: import static java.lang.annotation.ElementType.FIELD; ohair@286: import static java.lang.annotation.ElementType.METHOD; ohair@286: ohair@286: import org.w3c.dom.Element; ohair@286: import javax.xml.bind.JAXBElement; ohair@286: ohair@286: /** ohair@286: *

ohair@286: * Annotate a JavaBean multi-valued property to support mixed content. ohair@286: * ohair@286: *

ohair@286: * The usage is subject to the following constraints: ohair@286: *

ohair@286: *

ohair@286: * The following can be inserted into @XmlMixed annotated multi-valued property ohair@286: *

ohair@286: * ohair@286: * Below is an example of binding and creation of mixed content. ohair@286: * 
ohair@286:  *  <!-- schema fragment having  mixed content -->
ohair@286:  *  <xs:complexType name="letterBody" mixed="true">
ohair@286:  *    <xs:sequence>
ohair@286:  *      <xs:element name="name" type="xs:string"/>
ohair@286:  *      <xs:element name="quantity" type="xs:positiveInteger"/>
ohair@286:  *      <xs:element name="productName" type="xs:string"/>
ohair@286:  *      <!-- etc. -->
ohair@286:  *    </xs:sequence>
ohair@286:  *  </xs:complexType>
ohair@286:  *  <xs:element name="letterBody" type="letterBody"/>
ohair@286:  *
ohair@286:  * // Schema-derived Java code:
ohair@286:  * // (Only annotations relevant to mixed content are shown below,
ohair@286:  * //  others are ommitted.)
ohair@286:  * import java.math.BigInteger;
ohair@286:  * public class ObjectFactory {
ohair@286:  *      // element instance factories
ohair@286:  *      JAXBElement<LetterBody> createLetterBody(LetterBody value);
ohair@286:  *      JAXBElement<String>     createLetterBodyName(String value);
ohair@286:  *      JAXBElement<BigInteger> createLetterBodyQuantity(BigInteger value);
ohair@286:  *      JAXBElement<String>     createLetterBodyProductName(String value);
ohair@286:  *      // type instance factory
ohair@286:  *      LetterBody> createLetterBody();
ohair@286:  * }
ohair@286:  *
ohair@286: * 
ohair@286:  * public class LetterBody {
ohair@286:  *      // Mixed content can contain instances of Element classes
ohair@286:  *      // Name, Quantity and ProductName. Text data is represented as
ohair@286:  *      // java.util.String for text.
ohair@286:  *      @XmlMixed
ohair@286:  *      @XmlElementRefs({
ohair@286:  *              @XmlElementRef(name="productName", type=JAXBElement.class),
ohair@286:  *              @XmlElementRef(name="quantity", type=JAXBElement.class),
ohair@286:  *              @XmlElementRef(name="name", type=JAXBElement.class)})
ohair@286:  *      List getContent(){...}
ohair@286:  * }
ohair@286:  *
ohair@286: * The following is an XML instance document with mixed content ohair@286: * 
ohair@286:  * <letterBody>
ohair@286:  * Dear Mr.<name>Robert Smith</name>
ohair@286:  * Your order of <quantity>1</quantity> <productName>Baby
ohair@286:  * Monitor</productName> shipped from our warehouse. ....
ohair@286:  * </letterBody>
ohair@286:  *
ohair@286: * that can be constructed using following JAXB API calls. ohair@286: * 
ohair@286:  * LetterBody lb = ObjectFactory.createLetterBody();
ohair@286:  * JAXBElement<LetterBody> lbe = ObjectFactory.createLetterBody(lb);
ohair@286:  * List gcl = lb.getContent();  //add mixed content to general content property.
ohair@286:  * gcl.add("Dear Mr.");  // add text information item as a String.
ohair@286:  *
ohair@286:  * // add child element information item
ohair@286:  * gcl.add(ObjectFactory.createLetterBodyName("Robert Smith"));
ohair@286:  * gcl.add("Your order of "); // add text information item as a String
ohair@286:  *
ohair@286:  * // add children element information items
ohair@286:  * gcl.add(ObjectFactory.
ohair@286:  *                      createLetterBodyQuantity(new BigInteger("1")));
ohair@286:  * gcl.add(ObjectFactory.createLetterBodyProductName("Baby Monitor"));
ohair@286:  * gcl.add("shipped from our warehouse");  // add text information item
ohair@286:  *
ohair@286: * ohair@286: *

See "Package Specification" in javax.xml.bind.package javadoc for ohair@286: * additional common information.

ohair@286: * @author Kohsuke Kawaguchi ohair@286: * @since JAXB2.0 ohair@286: */ ohair@286: @Retention(RUNTIME) ohair@286: @Target({FIELD,METHOD}) ohair@286: public @interface XmlMixed { ohair@286: }