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