javax.xml.bind.annotation.XmlElementWrapper Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2013 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
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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 javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Generates a wrapper element around XML representation.
*
* This is primarily intended to be used to produce a wrapper
* XML element around collections. The annotation therefore supports
* two forms of serialization shown below.
*
*
* //Example: code fragment
* int[] names;
*
* // XML Serialization Form 1 (Unwrapped collection)
* <names> ... </names>
* <names> ... </names>
*
* // XML Serialization Form 2 ( Wrapped collection )
* <wrapperElement>
* <names> value-of-item </names>
* <names> value-of-item </names>
* ....
* </wrapperElement>
*
*
* The two serialized XML forms allow a null collection to be
* represented either by absence or presence of an element with a
* nillable attribute.
*
*
Usage
*
* The @XmlElementWrapper annotation can be used with the
* following program elements:
*
* - JavaBean property
* - non static, non transient field
*
*
* The usage is subject to the following constraints:
*
* - The property must be a collection property
* - This annotation can be used with the following annotations:
* {@link XmlElement},
* {@link XmlElements},
* {@link XmlElementRef},
* {@link XmlElementRefs},
* {@link XmlJavaTypeAdapter}.
*
*
* See "Package Specification" in javax.xml.bind.package javadoc for
* additional common information.
*
* @author - Kohsuke Kawaguchi, Sun Microsystems, Inc.
- Sekhar Vajjhala, Sun Microsystems, Inc.
* @see XmlElement
* @see XmlElements
* @see XmlElementRef
* @see XmlElementRefs
* @since JAXB2.0
*
*/
@Retention(RUNTIME) @Target({FIELD, METHOD})
public @interface XmlElementWrapper {
/**
* Name of the XML wrapper element. By default, the XML wrapper
* element name is derived from the JavaBean property name.
*/
String name() default "##default";
/**
* XML target namespace of the XML wrapper element.
*
* If the value is "##default", then the namespace is determined
* as follows:
*
* -
* If the enclosing package has {@link XmlSchema} annotation,
* and its {@link XmlSchema#elementFormDefault() elementFormDefault}
* is {@link XmlNsForm#QUALIFIED QUALIFIED}, then the namespace of
* the enclosing class.
*
*
-
* Otherwise "" (which produces unqualified element in the default
* namespace.
*
*/
String namespace() default "##default";
/**
* If true, the absence of the collection is represented by
* using xsi:nil='true'. Otherwise, it is represented by
* the absence of the element.
*/
boolean nillable() default false;
/**
* Customize the wrapper element declaration to be required.
*
*
* If required() is true, then the corresponding generated
* XML schema element declaration will have minOccurs="1",
* to indicate that the wrapper element is always expected.
*
*
* Note that this only affects the schema generation, and
* not the unmarshalling or marshalling capability. This is
* simply a mechanism to let users express their application constraints
* better.
*
* @since JAXB 2.1
*/
boolean required() default false;
}