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

Go to download
/*
 * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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.*;

/**
 * 
 * Enables mapping a class to a  XML Schema complex type with a
 * simpleContent or a XML Schema simple type. 
 * 
 *
 * 
 *  Usage: 
 * 

 * The {@code @XmlValue} annotation can be used with the following program
 * elements: 
 * 
 
 *    a JavaBean property.
 *    non static, non transient field.
 * 
 * 
 * See "Package Specification" in javax.xml.bind.package javadoc for
 * additional common information.
 *
 * The usage is subject to the following usage constraints:
 * 
 *   At most one field or property can be annotated with the
 *       {@code @XmlValue} annotation. 
 *
 *   {@code @XmlValue} can be used with the following
 *   annotations: {@link XmlList}. However this is redundant since
 *   {@link XmlList} maps a type to a simple schema type that derives by
 *   list just as {@link XmlValue} would. 
 *
 *   If the type of the field or property is a collection type,
 *       then the collection item type must map to a simple schema
 *       type.  
 * 
 *   If the type of the field or property is not a collection
 *       type, then the type must map to a XML Schema simple type. 
 *
 * 
 * 
 * If the annotated JavaBean property is the sole class member being
 * mapped to XML Schema construct, then the class is mapped to a
 * simple type. 
 *
 * If there are additional JavaBean properties (other than the
 * JavaBean property annotated with {@code @XmlValue} annotation)
 * that are mapped to XML attributes, then the class is mapped to a
 * complex type with simpleContent.
 * 
 *
 *   Example 1:  Map a class to XML Schema simpleType
 *
 *    * 
 *     // Example 1: Code fragment
 *     public class USPrice {
 *         @XmlValue
 *         public java.math.BigDecimal price;
 *     }
 * {@code
 * 
 *     
 *     
 *       
 *     
 *
 * }
 * 
 *  Example 2:  Map a class to XML Schema complexType with
 *        with simpleContent.
 * 
 *    *
 *   // Example 2: Code fragment
 *   public class InternationalPrice {
 *       @XmlValue
 *       public java.math.BigDecimal price;
 * 
 *       @XmlAttribute
 *       public String currency;
 *   }
 * {@code
 * 
 *   
 *   
 *     
 *       
 *         
 *       
 *     
 *   
 *
 * }
 *
 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
 * @see XmlType
 * @since 1.6, JAXB 2.0
 */

@Retention(RUNTIME) @Target({FIELD, METHOD})
public @interface XmlValue {}