aoqi@0: /*
aoqi@0:  * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.bind.annotation;
aoqi@0: 
aoqi@0: import java.lang.annotation.Target;
aoqi@0: import java.lang.annotation.Retention;
aoqi@0: import static java.lang.annotation.ElementType.*;
aoqi@0: import static java.lang.annotation.RetentionPolicy.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * <p>
aoqi@0:  * Prevents the mapping of a JavaBean property/type to XML representation.
aoqi@0:  * <p>
aoqi@0:  * The <tt>@XmlTransient</tt> annotation is useful for resolving name
aoqi@0:  * collisions between a JavaBean property name and a field name or
aoqi@0:  * preventing the mapping of a field/property. A name collision can
aoqi@0:  * occur when the decapitalized JavaBean property name and a field
aoqi@0:  * name are the same. If the JavaBean property refers to the field,
aoqi@0:  * then the name collision can be resolved by preventing the
aoqi@0:  * mapping of either the field or the JavaBean property using the
aoqi@0:  * <tt>@XmlTransient</tt> annotation.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * When placed on a class, it indicates that the class shouldn't be mapped
aoqi@0:  * to XML by itself. Properties on such class will be mapped to XML along
aoqi@0:  * with its derived classes, as if the class is inlined.
aoqi@0:  *
aoqi@0:  * <p><b>Usage</b></p>
aoqi@0:  * <p> The <tt>@XmlTransient</tt> annotation can be used with the following
aoqi@0:  *     program elements:
aoqi@0:  * <ul>
aoqi@0:  *   <li> a JavaBean property </li>
aoqi@0:  *   <li> field </li>
aoqi@0:  *   <li> class </li>
aoqi@0:  * </ul>
aoqi@0:  *
aoqi@0:  * <p><tt>@XmlTransient</tt>is mutually exclusive with all other
aoqi@0:  * JAXB defined annotations. </p>
aoqi@0:  *
aoqi@0:  * <p>See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0:  * additional common information.</p>
aoqi@0:  *
aoqi@0:  * <p><b>Example:</b> Resolve name collision between JavaBean property and
aoqi@0:  *     field name </p>
aoqi@0:  *
aoqi@0:  * <pre>
aoqi@0:  *   // Example: Code fragment
aoqi@0:  *   public class USAddress {
aoqi@0:  *
aoqi@0:  *       // The field name "name" collides with the property name
aoqi@0:  *       // obtained by bean decapitalization of getName() below
aoqi@0:  *       &#64;XmlTransient public String name;
aoqi@0:  *
aoqi@0:  *       String getName() {..};
aoqi@0:  *       String setName() {..};
aoqi@0:  *   }
aoqi@0:  *
aoqi@0:  *
aoqi@0:  *   &lt;!-- Example: XML Schema fragment -->
aoqi@0:  *   &lt;xs:complexType name="USAddress">
aoqi@0:  *     &lt;xs:sequence>
aoqi@0:  *       &lt;xs:element name="name" type="xs:string"/>
aoqi@0:  *     &lt;/xs:sequence>
aoqi@0:  *   &lt;/xs:complexType>
aoqi@0:  * </pre>
aoqi@0:  *
aoqi@0:  * @author Sekhar Vajjhala, Sun Microsystems, Inc.
aoqi@0:  * @since JAXB2.0
aoqi@0:  */
aoqi@0: 
aoqi@0: @Retention(RUNTIME) @Target({FIELD, METHOD, TYPE})
aoqi@0: public @interface XmlTransient {}