javax.xml.bind.annotation.XmlAccessorType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaxb-api-osgi Show documentation
JAXB (JSR 222) API bundled for OSGi distribution
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005-2010 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/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 packager/legal/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 javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.Inherited;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

/**
 *  Controls whether fields or Javabean properties are serialized by default. 
 * 
 *   Usage  
 *
 *  @XmlAccessorType annotation can be used with the following program elements:
 * 
 *  
 *    package
 *    a top level class 
 * 
 *
 *  See "Package Specification" in javax.xml.bind.package javadoc for
 * additional common information.
 *
 * This annotation provides control over the default serialization
 * of properties and fields in a class.
 * 
 * 
The annotation  @XmlAccessorType  on a package applies to
 * all classes in the package. The following inheritance
 * semantics apply:
 *
 * 

 *    If there is a @XmlAccessorType on a class, then it
 *        is used.   
 *    Otherwise, if a @XmlAccessorType exists on one of
 *        its super classes, then it is inherited.
 *   
 Otherwise, the @XmlAccessorType  on a package is
 *        inherited.
 * 
 *   Defaulting Rules:  
 *
 * By default, if @XmlAccessorType  on a package is absent,
 * then the following package level annotation is assumed.
 *  *   @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
 * 
 *  By default, if @XmlAccessorType on a class is absent,
 * and none of its super classes is annotated with
 * @XmlAccessorType, then the following default on the class
 * is assumed: 
 *  *   @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
 * 
 * This annotation can be used with the following annotations: 
 *    {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder}, 
 *    {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}, 
 *    , {@link XmlJavaTypeAdapter}. It can also be used with the
 *    following annotations at the package level: {@link XmlJavaTypeAdapter}.
 *
 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
 * @since JAXB2.0
 * @see XmlAccessType
 */

@Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE})
public @interface XmlAccessorType {

    /**
     * Specifies whether fields or properties are serialized. 
     * 
     * @see XmlAccessType
     */
    XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER;
}