Module  java.xml.bind
软件包  javax.xml.bind.annotation

Annotation Type XmlElementWrapper


  • @Retention(RUNTIME)
@Target({字段,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>

    两个序列化XML表单允许通过缺少或存在具有nillable属性的元素来表示空集合。

    用法

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

    • JavaBean属性
    • 非静态，非瞬态场

    用法受以下限制：

    有关其他常见信息，请参阅javax.xml.bind.package javadoc中的“Package Specification”。

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

    • Optional Element Summary

      Optional Elements  
      Modifier and Type Optional Element 描述
      String name
      XML包装元素的名称。
      String namespace
      XML包装器元素的XML目标命名空间。
      boolean nillable
      如果为真，则使用 xsi:nil='true'表示收集的不存在。
      boolean required
      自定义包装器元素声明是必需的。

    • Element Detail

      • name

        String name
        XML包装元素的名称。 默认情况下，XML包装器元素名称是从JavaBean属性名称派生的。
        Default:
        “＃＃默认”

      • namespace

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

        如果值为“## default”，则命名空间的确定如下：

        1. 如果封装包有XmlSchema注解，其elementFormDefault为QUALIFIED ， 则为封闭类的命名空间。
        2. 否则“”（它在默认命名空间中产生不合格的元素。
        Default:
        “＃＃默认”

      • nillable

        boolean nillable
        如果为真，则使用xsi:nil='true'表示不存在集合。 否则，它由缺少元素表示。
        Default:
        假

      • required

        boolean required
        自定义包装器元素声明是必需的。

        如果required（）为true，则相应的生成的XML模式元素声明将具有minOccurs="1" ，以指示包装器元素始终是预期的。

        请注意，这仅影响模式生成，而不影响解组或编组功能。 这只是让用户更好地表达其应用程序约束的一种机制。

        从以下版本开始：
        1.6，JAXB 2.1
        Default:
        假