/* * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ 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: *
The usage is subject to the following constraints: *
See "Package Specification" in javax.xml.bind.package javadoc for * additional common information.
* * @author* If the value is "##default", then the namespace is determined * as follows: *
* 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; }