Java™ Platform
Standard Ed. 8
javax.xml.bind.annotation

Annotation Type XmlList



  • @Retention(value=RUNTIME)
     @Target(value={FIELD,METHOD,PARAMETER})
    public @interface XmlList
    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>def
     </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
     </foo>
     

    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:
    JAXB2.0
Java™ Platform
Standard Ed. 8

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

微信小程序

微信扫一扫体验

微信公众账号

微信扫一扫加关注

发表
评论
返回
顶部