XmlElementWrapper (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：必需 | 可选

详细信息：元素

javax.xml.bind.annotation
注释类型 XmlElementWrapper

@Retention(value=RUNTIME) @Target(value={FIELD,METHOD}) public @interface XmlElementWrapper

生成一个包装 XML 表示形式的包装器元素。此元素主要用于生成一个包装集合的包装器 XML 元素。因此，该注释支持以下两种形式的序列化。

//Example:code fragment
int[] names;

// XML Serialization Form 1 (Unwrapped collection)
<names> ...</names>
<names> ...</names>
 
// XML Serialization Form 2 ( Wrapped collection )
<wrapperElement>
<names> value-of-item </names>
<names> value-of-item </names>
       ....
</wrapperElement>

通过使用或不使用具有 nillable 属性的元素，两种序列化的 XML 形式可以表示 null 集合。

使用

@XmlElementWrapper 注释可以与以下程序元素一起使用：

JavaBean 属性
非 static、非 transient 字段

用法受到以下约束的限制：

该属性必须是一个集合属性
此注释可与以下注释一起使用：XmlElement、XmlElements、XmlElementRef、XmlElementRefs、XmlJavaTypeAdapter。

有关其他公共消息，请参阅 javax.xml.bind.package javadoc 中的“包规范”。

从以下版本开始：: JAXB 2.0
另请参见：: XmlElement, XmlElements, XmlElementRef, XmlElementRefs

可选元素摘要

String name
          XML 包装器元素的名称。

String namespace
          XML 包装器元素的 XML 目标名称空间。

boolean nillable
          如果为 true，则使用 xsi:nil='true' 表示集合不存在。

可选元素摘要
`String`	`name` XML 包装器元素的名称。
`String`	`namespace` XML 包装器元素的 XML 目标名称空间。
`boolean`	`nillable` 如果为 true，则使用 `xsi:nil='true'` 表示集合不存在。

name

public abstract String name

XML 包装器元素的名称。默认情况下，XML 包装器元素的名称派生于 JavaBean 属性名称。

默认值：: "##default"

namespace

public abstract String namespace

XML 包装器元素的 XML 目标名称空间。

如果该值为 "##default"，则名称空间通过以下方式确定：

如果封闭包中包含 XmlSchema 注释，并且其 elementFormDefault 为 QUALIFIED，则名称空间为封闭类的名称空间。
否则名称空间为 ""（这将导致在默认名称空间中生成非限定的元素）。

默认值：: "##default"

nillable

public abstract boolean nillable

如果为 true，则使用 xsi:nil='true' 表示集合不存在。否则通过不使用该元素来表示集合不存在。

默认值：: false

概述