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