XmlList (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.bind.annotation
annotation XmlList

java.lang.annotation.Annotation
  javax.xml.bind.annotation.XmlList

public interface annotation XmlList
extends Annotation

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:


 <foo>
   <data>abc</data>
   <data>def</data>
 </foo>

@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:


 <foo>
   <data>abc def</data>
 </foo>

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

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

Method Summary

Methods inherited from class java.lang.annotation.Annotation
`annotationType, equals, hashCode, toString`