Skip navigation links

Jakarta EE Platform API v9.0.0

Package jakarta.xml.bind.annotation

Defines annotations for customizing Java program elements to XML Schema mapping.

See: Description

Package jakarta.xml.bind.annotation Description

Defines annotations for customizing Java program elements to XML Schema mapping.

References in this document to JAXB refer to the Jakarta XML Binding unless otherwise noted.

Package Specification

The following table shows the Jakarta XML Binding mapping annotations that can be associated with each program element.

Annotations for customizing Java program elements to XML Schema mapping
Program Element Jakarta XML Binding annotation
Package
Class
Enum type
JavaBean Property/field
Parameter

Terminology

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

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

mapping annotation:A Jakarta XML Binding defined program annotation based on the JSR 175 programming annotation facility.

Common Usage Constraints

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

Notations

Namespace prefixes

The following namespace prefixes are used in the XML Schema fragments in this package.

XML Schema fragments namespace prefixes
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
Since:
1.6, JAXB 2.0
Skip navigation links

Jakarta EE Platform API v9.0.0

Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.