aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

aoqi@0: Defines annotations for customizing Java program elements to XML Schema mapping. aoqi@0: aoqi@0:

Package Specification

aoqi@0:

The following table shows the JAXB mapping annotations aoqi@0: that can be associated with each program element.

Program Element

JAXB annotation

Package

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

XmlAccessorOrder

XmlAccessorType

XmlSchema

XmlSchemaType

XmlSchemaTypes

XmlJavaTypeAdapter

XmlJavaTypeAdapters

aoqi@0:

Class

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

XmlAccessorOrder

XmlAccessorType

XmlInlineBinaryData

XmlRootElement

XmlType

XmlJavaTypeAdapter

aoqi@0:

Enum type

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

XmlEnum

XmlEnumValue (enum constant only)

XmlRootElement

XmlType

XmlJavaTypeAdapter

aoqi@0:

JavaBean Property/field

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

XmlElement

XmlElements

XmlElementRef

XmlElementRefs

XmlElementWrapper

XmlAnyElement

XmlAttribute

XmlAnyAttribute

XmlTransient

XmlValue

XmlID

XmlIDREF

XmlList

XmlMixed

XmlMimeType

XmlAttachmentRef

XmlInlineBinaryData

XmlElementDecl (only on method)

XmlJavaTypeAdapter

aoqi@0:

Parameter

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:

XmlList

XmlAttachmentRef

XmlMimeType

XmlJavaTypeAdapter

aoqi@0:

Terminology

aoqi@0:

aoqi@0: JavaBean property and field: For the purposes of aoqi@0: mapping, there is no semantic difference between a field and aoqi@0: a JavaBean property. Thus, an annotation that can be applied aoqi@0: to a JavaBean property can always be applied to a aoqi@0: field. Hence in the Javadoc documentation, for brevity, the aoqi@0: term JavaBean property or property is used to mean either JavaBean aoqi@0: property or a field. Where required, both are explicitly aoqi@0: mentioned. aoqi@0:

aoqi@0: top level class: For the purpose of mapping, there is aoqi@0: no semantic difference between a top level class and a aoqi@0: static nested class. Thus, an annotation that can be applied aoqi@0: to a top level class, can always be applied to a nested aoqi@0: static class. Hence in the Javadoc documentation, for aoqi@0: brevity, the term "top level class" or just class is used to aoqi@0: mean either a top level class or a nested static aoqi@0: class. aoqi@0:

aoqi@0: mapping annotation:A JAXB 2.0 defined program aoqi@0: annotation based on the JSR 175 programming annotation aoqi@0: facility. aoqi@0:

Common Usage Constraints

aoqi@0:

The following usage constraints are defined here since aoqi@0: they apply to more than annotation: aoqi@0:

For a property, a given annotation can be applied to aoqi@0: either read or write property but not both.
A property name must be different from any other aoqi@0: property name in any of the super classes of the aoqi@0: class being mapped.
A mapped field name or the decapitalized name of a aoqi@0: mapped property must be unique within a class.

aoqi@0:

Notations

aoqi@0: Namespace prefixes aoqi@0:

The following namespace prefixes are used in the XML Schema aoqi@0: fragments in this package.

aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0: aoqi@0:
Prefix Namespace Notes
xs http://www.w3.org/2001/XMLSchema Namespace of XML Schema namespace
ref http://ws-i.org/profiles/basic/1.1/xsd Namespace for swaref schema component
xsi http://www.w3.org/2001/XMLSchema-instance XML Schema namespace for instances
aoqi@0: aoqi@0: aoqi@0: @since JAXB 2.0 aoqi@0: aoqi@0: aoqi@0: aoqi@0:

Prefix	Namespace	Notes
xs	http://www.w3.org/2001/XMLSchema	Namespace of XML Schema namespace
ref	http://ws-i.org/profiles/basic/1.1/xsd	Namespace for swaref schema component
xsi	http://www.w3.org/2001/XMLSchema-instance	XML Schema namespace for instances