Package jakarta.xml.bind.annotation
Annotation Type XmlValue
-
@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface XmlValueEnables mapping a class to a XML Schema complex type with a simpleContent or an XML Schema simple type.
Usage:
The
@XmlValueannotation can be used with the following program elements:- a JavaBean property.
- non-static, non transient field.
See "Package Specification" in jakarta.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
@XmlValueannotation. @XmlValuecan be used with the following annotations:XmlList. However this is redundant sinceXmlListmaps a type to a simple schema type that derives by list just asXmlValuewould.- 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 an 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
@XmlValueannotation) 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
{@snippet : // Example 1: Code fragment public class USPrice {- Since:
- 1.6, JAXB 2.0
- Author:
- Sekhar Vajjhala, Sun Microsystems, Inc.
- See Also:
XmlType