src/share/jaxws_classes/javax/xml/bind/annotation/XmlTransient.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind.annotation;
ohair@286 27
ohair@286 28 import java.lang.annotation.Target;
ohair@286 29 import java.lang.annotation.Retention;
ohair@286 30 import static java.lang.annotation.ElementType.*;
ohair@286 31 import static java.lang.annotation.RetentionPolicy.*;
ohair@286 32
ohair@286 33 /**
ohair@286 34 * <p>
ohair@286 35 * Prevents the mapping of a JavaBean property/type to XML representation.
ohair@286 36 * <p>
ohair@286 37 * The <tt>@XmlTransient</tt> annotation is useful for resolving name
ohair@286 38 * collisions between a JavaBean property name and a field name or
ohair@286 39 * preventing the mapping of a field/property. A name collision can
ohair@286 40 * occur when the decapitalized JavaBean property name and a field
ohair@286 41 * name are the same. If the JavaBean property refers to the field,
ohair@286 42 * then the name collision can be resolved by preventing the
ohair@286 43 * mapping of either the field or the JavaBean property using the
ohair@286 44 * <tt>@XmlTransient</tt> annotation.
ohair@286 45 *
ohair@286 46 * <p>
ohair@286 47 * When placed on a class, it indicates that the class shouldn't be mapped
ohair@286 48 * to XML by itself. Properties on such class will be mapped to XML along
ohair@286 49 * with its derived classes, as if the class is inlined.
ohair@286 50 *
ohair@286 51 * <p><b>Usage</b></p>
ohair@286 52 * <p> The <tt>@XmlTransient</tt> annotation can be used with the following
ohair@286 53 * program elements:
ohair@286 54 * <ul>
ohair@286 55 * <li> a JavaBean property </li>
ohair@286 56 * <li> field </li>
ohair@286 57 * <li> class </li>
ohair@286 58 * </ul>
ohair@286 59 *
ohair@286 60 * <p><tt>@XmlTransient</tt>is mutually exclusive with all other
ohair@286 61 * JAXB defined annotations. </p>
ohair@286 62 *
ohair@286 63 * <p>See "Package Specification" in javax.xml.bind.package javadoc for
ohair@286 64 * additional common information.</p>
ohair@286 65 *
ohair@286 66 * <p><b>Example:</b> Resolve name collision between JavaBean property and
ohair@286 67 * field name </p>
ohair@286 68 *
ohair@286 69 * <pre>
ohair@286 70 * // Example: Code fragment
ohair@286 71 * public class USAddress {
ohair@286 72 *
ohair@286 73 * // The field name "name" collides with the property name
ohair@286 74 * // obtained by bean decapitalization of getName() below
ohair@286 75 * &#64;XmlTransient public String name;
ohair@286 76 *
ohair@286 77 * String getName() {..};
ohair@286 78 * String setName() {..};
ohair@286 79 * }
ohair@286 80 *
ohair@286 81 *
ohair@286 82 * &lt;!-- Example: XML Schema fragment -->
ohair@286 83 * &lt;xs:complexType name="USAddress">
ohair@286 84 * &lt;xs:sequence>
ohair@286 85 * &lt;xs:element name="name" type="xs:string"/>
ohair@286 86 * &lt;/xs:sequence>
ohair@286 87 * &lt;/xs:complexType>
ohair@286 88 * </pre>
ohair@286 89 *
ohair@286 90 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
ohair@286 91 * @since JAXB2.0
ohair@286 92 */
ohair@286 93
ohair@286 94 @Retention(RUNTIME) @Target({FIELD, METHOD, TYPE})
ohair@286 95 public @interface XmlTransient {}

mercurial