XmlList (Java EE 5)

Java EE API

previous page next page

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: REQUIRED | OPTIONAL

DETAIL: ELEMENT

javax.xml.bind.annotation Annotation Type XmlList

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

Implements: Annotation

@Retention(value=RUNTIME)
@Target(value={FIELD, METHOD, PARAMETER})

用来将属性映射到列表简单类型。

用法

@XmlList 注释能够与以下程序元素一起使用：

JavaBean 属性
字段

在集合属性仅使用 @XmlElement 进行注释时，将通过元素包装集合中的每一个项。例如，

 @XmlRootElement
 class Foo {
     @XmlElement
     List<String> data;
 }

将生成如下 XML：


 &lt;foo&gt;
&lt;data&gt;abc&lt;/data&gt;
&lt;data&gt;def&lt;/data&gt;
 &lt;/foo&gt;

另一方面，@XmlList 注释允许将多个值表示为单个元素中以空格分隔的标记。例如，

 @XmlRootElement
 class Foo {
     @XmlElement
     @XmlList
     List<String> data;
 }

上述代码将生成如下 XML：


 &lt;foo&gt;
&lt;data&gt;abc def&lt;/data&gt;
 &lt;/foo&gt;

此注释可与以下注释一起使用：XmlElement、XmlAttribute、XmlValue 和 XmlIDREF。

使用 @XmlList 和 XmlValue（在允许的情况下）是多余的，因为 XmlList 将集合类型映射到一个简单模式类型，该简单模式类型就像 XmlValue 那样是由列表派生的。
使用 @XmlList 和 XmlAttribute（在允许的情况下）是多余的，因为 XmlList 将集合类型映射到一个简单模式类型，该简单模式类型就像 XmlAttribute 那样是由列表派生的。

since

JAXB2.0

英文文档：

Used to map a property to a list simple type.

Usage

The @XmlList annotation can be used with the following program elements:

JavaBean property
field

When a collection property is annotated just with @XmlElement, each item in the collection will be wrapped by an element. For example,

 @XmlRootElement
 class Foo {
     @XmlElement
     List<String> data;
 }

would produce XML like this:


 &lt;foo&gt;
   &lt;data&gt;abc&lt;/data&gt;
   &lt;data&gt;def&lt;/data&gt;
 &lt;/foo&gt;

@XmlList annotation, on the other hand, allows multiple values to be represented as whitespace-separated tokens in a single element. For example,

 @XmlRootElement
 class Foo {
     @XmlElement
     @XmlList
     List<String> data;
 }

the above code will produce XML like this:


 &lt;foo&gt;
   &lt;data&gt;abc def&lt;/data&gt;
 &lt;/foo&gt;

This annotation can be used with the following annotations: XmlElement, XmlAttribute, XmlValue, XmlIDREF.

The use of @XmlList with XmlValue while allowed, is redundant since XmlList maps a collection type to a simple schema type that derives by list just as XmlValue would.
The use of @XmlList with XmlAttribute while allowed, is redundant since XmlList maps a collection type to a simple schema type that derives by list just as XmlAttribute would.

Since: