javax.xml.bind.annotation.XmlTransient Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.bind.annotation;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
/**
*
* Prevents the mapping of a JavaBean property/type to XML representation.
*
* The {@code @XmlTransient} annotation is useful for resolving name
* collisions between a JavaBean property name and a field name or
* preventing the mapping of a field/property. A name collision can
* occur when the decapitalized JavaBean property name and a field
* name are the same. If the JavaBean property refers to the field,
* then the name collision can be resolved by preventing the
* mapping of either the field or the JavaBean property using the
* {@code @XmlTransient} annotation.
*
*
* When placed on a class, it indicates that the class shouldn't be mapped
* to XML by itself. Properties on such class will be mapped to XML along
* with its derived classes, as if the class is inlined.
*
*
Usage
* The {@code @XmlTransient} annotation can be used with the following
* program elements:
*
* - a JavaBean property
* - field
* - class
*
*
* {@code @XmlTransient} is mutually exclusive with all other
* JAXB defined annotations.
*
* See "Package Specification" in javax.xml.bind.package javadoc for
* additional common information.
*
* Example: Resolve name collision between JavaBean property and
* field name
*
*
* // Example: Code fragment
* public class USAddress {
*
* // The field name "name" collides with the property name
* // obtained by bean decapitalization of getName() below
* @XmlTransient public String name;
*
* String getName() {..};
* String setName() {..};
* }
*
* {@code
*
*
*
*
*
*
* }
*
* @author Sekhar Vajjhala, Sun Microsystems, Inc.
* @since 1.6, JAXB 2.0
*/
@Retention(RUNTIME) @Target({FIELD, METHOD, TYPE})
public @interface XmlTransient {}