jakarta.xml.bind.annotation.XmlMixed Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package jakarta.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 jakarta.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 Jakarta XML Binding mapped class is inserted
 * as {@link Element}. (Assumes property annotated with @XmlAnyElement)
 * 
 *
 * Below is an example of binding and creation of mixed content.
 * {@snippet lang="XML" :
 *  
 *  
 *    
 *      
 *      
 *      
 *      
 *    
 *  
 *  
 * }
 * {@snippet :
 *  // Schema-derived Java code: 
 *  // (Only annotations relevant to mixed content are shown below, 
 *  //  others are omitted.)
 *  import java.math.BigInteger;
 *  public class ObjectFactory {
 *      // element instance factories
 *      JAXBElement createLetterBody(LetterBody value);
 *      JAXBElement     createLetterBodyName(String value);
 *      JAXBElement createLetterBodyQuantity(BigInteger value);
 *      JAXBElement     createLetterBodyProductName(String value);
 *      // type instance factory
 *      LetterBody createLetterBody();
 *  }
 * }
 * {@snippet :
 *  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
 * {@snippet lang="XML" :
 *  
 *    Dear Mr.Robert Smith
 *    Your order of 1 Baby
 *    Monitor shipped from our warehouse. ....
 *  
 * }
 * that can be constructed using following Jakarta XML Binding API calls.
 * {@snippet :
 *  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 jakarta.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 {
}