Module
java.xml.bind
Package javax.xml.bind.annotation
定义用于将Java程序元素定制到XML模式映射的注释。
包装规格
下表显示了可以与每个程序元素相关联的JAXB映射注释。
Program Element JAXB annotation 软件包XmlAccessorOrder |
XmlAccessorType |
XmlSchema |
XmlSchemaType |
XmlSchemaTypes |
XmlJavaTypeAdapter |
XmlJavaTypeAdapters |
XmlAccessorOrder |
XmlAccessorType |
XmlInlineBinaryData |
XmlRootElement |
XmlType |
XmlJavaTypeAdapter |
XmlEnum |
XmlEnumValue (enum constant only) |
XmlRootElement |
XmlType |
XmlJavaTypeAdapter |
XmlList |
XmlAttachmentRef |
XmlMimeType |
XmlJavaTypeAdapter |
术语
JavaBean属性和字段:为了映射的目的,字段和JavaBean属性之间没有语义上的区别。 因此,可以将可应用于JavaBean属性的注释始终应用于一个字段。 因此,在Javadoc文档中,为简洁起见,术语JavaBean属性或属性用于表示JavaBean属性或字段。 如有需要,两者均明确提及。
顶级类:为了映射的目的,顶级类和静态嵌套类之间没有语义上的差别。 因此,可以应用于顶级类的注释总是可以应用于嵌套的静态类。 因此,在Javadoc文档中,为了简洁起见,术语“顶级类”或只是类用于表示顶级类或嵌套静态类。
映射注释:基于JSR 175编程注释工具的JAXB 2.0定义的程序注释。
常见的使用限制
这里定义了以下使用限制,因为它们适用于多于注释:
- 对于属性,给定的注释可以应用于读取或写入属性,但不能同时应用于两者。
- 属性名称必须与被映射的类的任何超级类中的任何其他属性名称不同。
- 映射字段名称或映射属性的非转换名称在类中必须是唯一的。
不缩
命名空间前缀以下命名空间前缀在此包中的XML模式片段中使用。
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- 从以下版本开始:
- 1.6, JAXB 2.0
-
接口摘要 接口 描述 DomHandler<ElementT,ResultT extends Result> 将元素(及其后代)从/转换为DOM(或类似的)表示形式。 -
类摘要 Class 描述 W3CDomHandler DomHandler
W3C DOM实现(org.w3c.dom
包)XmlElement.DEFAULT 在XmlElement.type()
中用于表示从属性的签名中推断出该类型。XmlElementDecl.GLOBAL 用于XmlElementDecl.scope()
以表示声明在全局范围内。XmlElementRef.DEFAULT 在XmlElementRef.type()
中用于表示从属性的签名中推断出该类型。XmlSchemaType.DEFAULT 在XmlSchemaType.type()
中用于表示从属性的签名中推断出该类型。XmlType.DEFAULT 在XmlType.factoryClass()
中用于表示不使用工厂方法,或者它与本本中的这个XmlType
的类在一起。 -
枚举摘要 Enum 描述 XmlAccessOrder 由XmlAccessorOrder用于控制JAXB绑定类中的属性和字段的排序。XmlAccessType 由XmlAccessorType用于控制字段或属性的序列化。XmlNsForm 枚举XML Schema命名空间资格。 -
注解类型摘要 Annotation Type 描述 XmlAccessorOrder 控制类中字段和属性的顺序。XmlAccessorType 控制字段或Javabean属性是否默认序列化。XmlAnyAttribute 将JavaBean属性映射到通配符属性的映射。XmlAnyElement 将JavaBean属性映射到XML信息集表示和/或JAXB元素。XmlAttachmentRef 标记一个字段/属性,它的XML表单是一个uri引用mime内容。XmlAttribute 将JavaBean属性映射到XML属性。XmlElement 将JavaBean属性映射到从属性名称派生的XML元素。XmlElementDecl 将工厂方法映射到XML元素。XmlElementRef 将JavaBean属性映射到从属性类型派生的XML元素。XmlElementRefs 标记带有XmlElement
或JAXBElement的类的属性。XmlElements 多个@XmlElement
注释的容器。XmlElementWrapper 围绕XML表示生成一个包装元素。XmlEnum 将枚举类型映射到XML表示形式。XmlEnumValue 将一个枚举常量映射到Enum
类型到XML表示。XmlID 将JavaBean属性映射到XML ID。XmlIDREF 将JavaBean属性映射到XML IDREF。XmlInlineBinaryData 禁用对XML绑定到base64编码的二进制数据的数据类型的XOP编码的考虑。XmlList 用于将属性映射到列表简单类型。XmlMimeType 关联控制属性的XML表示形式的MIME类型。XmlMixed 注释JavaBean多值属性以支持混合内容。XmlNs 将命名空间前缀与XML命名空间URI相关联。XmlRegistry 标记一个有XmlElementDecl
的类。XmlRootElement 将类或枚举类型映射到XML元素。XmlSchema 将包名称映射到XML命名空间。XmlSchemaType 将Java类型映射到简单的模式内置类型。XmlSchemaTypes 多个@XmlSchemaType
注释的容器。XmlSeeAlso 指示JAXB在绑定此类时也绑定其他类。XmlTransient 防止将JavaBean属性/类型映射到XML表示。XmlType 将类或枚举类型映射到XML模式类型。XmlValue 使用simpleContent或XML Schema简单类型将类映射到XML模式复合类型。