javax.xml.bind.annotation.XmlMixed Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
Show all versions of ehcache Show documentation
Ehcache is an open source, standards-based cache used to boost performance,
offload the database and simplify scalability. Ehcache is robust, proven and full-featured and
this has made it the most widely-used Java-based cache.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.bind.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import org.w3c.dom.Element;
import javax.xml.bind.JAXBElement;
/**
*
* Annotate a JavaBean multi-valued property to support mixed content.
*
*
* The usage is subject to the following constraints:
*
* - can be used with @XmlElementRef, @XmlElementRefs or @XmlAnyElement
*
*
* The following can be inserted into @XmlMixed annotated multi-valued property
*
* - XML text information items are added as values of java.lang.String.
* - Children element information items are added as instances of
* {@link JAXBElement} or instances with a class that is annotated with
* @XmlRootElement.
* - Unknown content that is not be bound to a JAXB mapped class is inserted
* as {@link Element}. (Assumes property annotated with @XmlAnyElement)
*
*
* Below is an example of binding and creation of mixed content.
* {@code
*
*
*
*
*
*
* createLetterBody(LetterBody value);
* JAXBElement createLetterBodyName(String value);
* JAXBElement createLetterBodyQuantity(BigInteger value);
* JAXBElement createLetterBodyProductName(String value);
* // type instance factory
* LetterBody createLetterBody();
* }
* }
*
* public class LetterBody {
* // Mixed content can contain instances of Element classes
* // Name, Quantity and ProductName. Text data is represented as
* // java.util.String for text.
* @XmlMixed
* @XmlElementRefs({
* @XmlElementRef(name="productName", type=JAXBElement.class),
* @XmlElementRef(name="quantity", type=JAXBElement.class),
* @XmlElementRef(name="name", type=JAXBElement.class)})
* List getContent(){...}
* }
*
* The following is an XML instance document with mixed content
* {@code
*
* Dear Mr.Robert Smith
* Your order of 1 Baby
* Monitor shipped from our warehouse. ....
*
* }
* that can be constructed using following JAXB API calls.
* {@code
* LetterBody lb = ObjectFactory.createLetterBody();
* JAXBElement lbe = ObjectFactory.createLetterBody(lb);
* List gcl = lb.getContent(); //add mixed content to general content property.
* gcl.add("Dear Mr."); // add text information item as a String.
*
* // add child element information item
* gcl.add(ObjectFactory.createLetterBodyName("Robert Smith"));
* gcl.add("Your order of "); // add text information item as a String
*
* // add children element information items
* gcl.add(ObjectFactory.
* createLetterBodyQuantity(new BigInteger("1")));
* gcl.add(ObjectFactory.createLetterBodyProductName("Baby Monitor"));
* gcl.add("shipped from our warehouse"); // add text information item
* }
*
* See "Package Specification" in javax.xml.bind.package javadoc for
* additional common information.
* @author Kohsuke Kawaguchi
* @since 1.6, JAXB 2.0
*/
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public @interface XmlMixed {
}