javax.xml.bind.annotation

接口
异常
注释
定义将 Java 程序元素定制成 XML 模式映射的注释。

请参见:
          描述

接口摘要
DomHandler<ElementT,ResultT extends Result> 在元素(及其子代)与 DOM(或类似对象)表示形式之间相互转换。
 

类摘要
W3CDomHandler W3C DOM(org.w3c.dom 包)的 DomHandler 实现。
XmlElement.DEFAULT XmlElement.type() 中使用,用于表示根据属性签名推断出来的类型。
XmlElementDecl.GLOBAL XmlElementDecl.scope() 中使用,指示声明是全局范围的。
XmlElementRef.DEFAULT XmlElementRef.type() 中使用,用于表示根据属性签名推断出来的类型。
XmlSchemaType.DEFAULT XmlSchemaType.type() 中使用,用于表示根据属性签名推断出来的类型。
XmlType.DEFAULT XmlType.factoryClass() 中使用,指示工厂方法未被使用或者在具有此 XmlType 的类中。
 

枚举摘要
XmlAccessOrder 由 XmlAccessorOrder 使用,用于控制 JAXB 绑定类中属性和字段的排序。
XmlAccessType 由 XmlAccessorType 使用,用于控制字段或属性的序列化。
XmlNsForm XML 模式名称空间限定的枚举。
 

注释类型摘要
XmlAccessorOrder 控制类中字段和属性的排序。
XmlAccessorType 控制默认情况下是否对字段或 Javabean 属性进行系列化。
XmlAnyAttribute 将 JavaBean 属性映射到通配符属性的映射表中。
XmlAnyElement 将 JavaBean 属性映射到 XML 信息集表示形式和/或 JAXB 元素。
XmlAttachmentRef 标记字段/属性,其 XML 形式是对 MIME 内容的 URI 引用。
XmlAttribute 将 JavaBean 属性映射到 XML 属性。
XmlElement 将 JavaBean 属性映射到派生于属性名称的 XML 元素。
XmlElementDecl 将工厂方法映射到 XML 元素。
XmlElementRef 将 JavaBean 属性映射到派生于属性类型的 XML 元素。
XmlElementRefs 标记一个属性,该属性引用带有 XmlElement 或 JAXBElement 的类。
XmlElements 多个 @XmlElement 注释的容器。
XmlElementWrapper 生成一个包装 XML 表示形式的包装器元素。
XmlEnum 将枚举类型 Enum 映射到 XML 表示形式。
XmlEnumValue Enum 类型中的枚举常量映射到 XML 表示形式。
XmlID 将 JavaBean 属性映射到 XML ID。
XmlIDREF 将 JavaBean 属性映射到 XML IDREF。
XmlInlineBinaryData 禁止对绑定到 XML 中 base64-encoded 二进制数据的数据类型进行 XOP 编码。
XmlList 用来将属性映射到列表简单类型。
XmlMimeType 关联控制属性 XML 表示形式的 MIME 类型。
XmlMixed 注释 JavaBean 多值属性,以支持混合内容。
XmlNs 关联名称空间前缀与 XML 名称空间 URI。
XmlRegistry 标记具有 XmlElementDecl 的类。
XmlRootElement 将类或枚举类型映射到 XML 元素。
XmlSchema 将包名称映射到 XML 名称空间。
XmlSchemaType 将 Java 类型映射到一个简单的模式内置类型。
XmlSchemaTypes 多个 @XmlSchemaType 注释的容器。
XmlTransient 阻止将 JavaBean 属性映射到 XML 表示形式。
XmlType 将类或枚举类型映射到 XML 模式类型。
XmlValue 支持将类映射到带有 simpleContent 的 XML 模式复杂类型或 XML 模式简单类型。
 

软件包 javax.xml.bind.annotation 的描述

定义将 Java 程序元素定制成 XML 模式映射的注释。

包规范

下表显示了可与每个程序元素关联的 JAXB 映射注释。

程序元素 JAXB 注释
XmlAccessorOrder
XmlAccessorType
XmlSchema
XmlSchemaType
XmlSchemaTypes
XmlJavaTypeAdapter
XmlJavaTypeAdapters
XmlAccessorOrder
XmlAccessorType
XmlInlineBinaryData
XmlRootElement
XmlType
XmlJavaTypeAdapter
枚举类型
XmlEnum
XmlEnumValue(仅限枚举常量)
XmlRootElement
XmlType
XmlJavaTypeAdapter
JavaBean 属性/字段
XmlElement
XmlElements
XmlElementRef
XmlElementRefs
XmlElementWrapper
XmlAnyElement
XmlAttribute
XmlAnyAttribute
XmlTransient
XmlValue
XmlID
XmlIDREF
XmlList
XmlMixed
XmlMimeType
XmlAttachmentRef
XmlInlineBinaryData
XmlElementDecl(仅用于方法)
XmlJavaTypeAdapter
参数
XmlList
XmlAttachmentRef
XmlMimeType
XmlJavaTypeAdapter

术语

JavaBean 属性和字段: 从映射的用途考虑,字段和 JavaBean 属性之间没有语义上的差别。因此,可以应用于 JavaBean 属性的注释总是可以应用于字段。简言之,在 Javadoc 文档中,使用术语 JavaBean 属性或属性表示 JavaBean 属性或字段。如有需要,两者可以不加区别的同时使用。

顶层类: 从映射的用途考虑,顶层类和静态嵌套类之间没有语义上的差别。因此,可以应用于顶层类的注释总是可以应用于嵌套静态类。简言之,在 Javadoc 文档中,使用术语“顶层类”或类表示顶层类或嵌套静态类。

映射注释:JAXB 2.0 基于 JSR 175 编程注释工具定义的程序注释。

公共用法约束

在这里定义以下用法约束,因为它们并不仅限于供注释使用:

  • 对于属性,给出的注释可以应用于 read 或 write 属性,但不能同时应用于二者。
  • 属性名称必须不同于将被映射类的任何超类中的其他任何属性名称。
  • 一个类中映射属性的映射字段名称或取消大写化的名称必须唯一。
  • 计数法

    名称空间前缀

    在此包中,以下名称空间前缀用于 XML 模式片段。

    前缀 名称空间 注释
    xs http://www.w3.org/2001/XMLSchema XML 模式名称空间的名称空间
    ref http://ws-i.org/profiles/basic/1.1/xsd swaref 模式组件的名称空间
    xsi http://www.w3.org/2001/XMLSchema-instance 实例的 XML 模式名称空间

    从以下版本开始:
    JAXB 2.0