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: *
aoqi@0: * Enables mapping a class to a XML Schema complex type with a aoqi@0: * simpleContent or a XML Schema simple type. aoqi@0: *
aoqi@0: * aoqi@0: *aoqi@0: * Usage: aoqi@0: *
aoqi@0: * The @XmlValue annotation can be used with the following program aoqi@0: * elements: aoqi@0: *
See "Package Specification" in javax.xml.bind.package javadoc for aoqi@0: * additional common information.
aoqi@0: * aoqi@0: * The usage is subject to the following usage constraints: aoqi@0: *aoqi@0: * If the annotated JavaBean property is the sole class member being aoqi@0: * mapped to XML Schema construct, then the class is mapped to a aoqi@0: * simple type. aoqi@0: * aoqi@0: * If there are additional JavaBean properties (other than the aoqi@0: * JavaBean property annotated with @XmlValue annotation) aoqi@0: * that are mapped to XML attributes, then the class is mapped to a aoqi@0: * complex type with simpleContent. aoqi@0: *
aoqi@0: * aoqi@0: *Example 1: Map a class to XML Schema simpleType
aoqi@0: * aoqi@0: *aoqi@0: * aoqi@0: * // Example 1: Code fragment aoqi@0: * public class USPrice { aoqi@0: * @XmlValue aoqi@0: * public java.math.BigDecimal price; aoqi@0: * } aoqi@0: * aoqi@0: * <!-- Example 1: XML Schema fragment --> aoqi@0: * <xs:simpleType name="USPrice"> aoqi@0: * <xs:restriction base="xs:decimal"/> aoqi@0: * </xs:simpleType> aoqi@0: * aoqi@0: *aoqi@0: * aoqi@0: *
Example 2: Map a class to XML Schema complexType with aoqi@0: * with simpleContent.
aoqi@0: * aoqi@0: *aoqi@0: * aoqi@0: * // Example 2: Code fragment aoqi@0: * public class InternationalPrice { aoqi@0: * @XmlValue aoqi@0: * public java.math.BigDecimal price; aoqi@0: * aoqi@0: * @XmlAttribute aoqi@0: * public String currency; aoqi@0: * } aoqi@0: * aoqi@0: * <!-- Example 2: XML Schema fragment --> aoqi@0: * <xs:complexType name="InternationalPrice"> aoqi@0: * <xs:simpleContent> aoqi@0: * <xs:extension base="xs:decimal"> aoqi@0: * <xs:attribute name="currency" type="xs:string"/> aoqi@0: * </xs:extension> aoqi@0: * </xs:simpleContent> aoqi@0: * </xs:complexType> aoqi@0: * aoqi@0: *aoqi@0: * aoqi@0: * aoqi@0: * @author Sekhar Vajjhala, Sun Microsystems, Inc. aoqi@0: * @see XmlType aoqi@0: * @since JAXB2.0 aoqi@0: */ aoqi@0: aoqi@0: @Retention(RUNTIME) @Target({FIELD, METHOD}) aoqi@0: public @interface XmlValue {}