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

Annotation Type XmlElement


  • @Retention(RUNTIME)
@Target({字段,METHOD,PARAMETER})
public @interface XmlElement
    将JavaBean属性映射到从属性名称派生的XML元素。

    用法

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

    • 一个JavaBean属性
    • 非静态，非瞬态场
    • 在XmlElements内
    用法受以下限制：

    当使用@XmlElement注释注释时，JavaBean属性将映射到包含类映射到的XML模式复合类型中的本地元素。

    示例1：将公共非静态非最终字段映射到本地元素 

      //Example: Code fragment
     public class USPrice {
        @XmlElement(name="itemprice")
         public java.math.BigDecimal price;
     }
  <!-- Example: Local XML Schema element --> <xs:complexType name="USPrice"/> <xs:sequence> <xs:element name="itemprice" type="xs:decimal" minOccurs="0"/> </sequence> </xs:complexType>

    示例2：将字段映射到可填充元素。 

      //Example: Code fragment
     public class USPrice {
        @XmlElement(nillable=true)
         public java.math.BigDecimal price;
     }
  <!-- Example: Local XML Schema element --> <xs:complexType name="USPrice"> <xs:sequence> <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="0"/> </sequence> </xs:complexType>

    示例3：将字段映射到可填充的必需元素。 

      //Example: Code fragment
     public class USPrice {
        @XmlElement(nillable=true, required=true)
         public java.math.BigDecimal price;
     }
  <!-- Example: Local XML Schema element --> <xs:complexType name="USPrice"> <xs:sequence> <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="1"/> </sequence> </xs:complexType>

    示例4：将JavaBean属性映射到具有匿名类型的XML元素。

    参见@ XmlType中的例6。

    从以下版本开始：
    1.6，JAXB 2.0

    • Optional Element Summary

      Optional Elements  
      Modifier and Type Optional Element 描述
      String defaultValue
      该元素的默认值。
      String name
      XML Schema元素的名称。
      String namespace
      XML Schema元素的XML目标命名空间。
      boolean nillable
      自定义元素声明为nillable。
      boolean required
      自定义元素声明是必需的。
      Class type
      Java类被引用。

    • Element Detail

      • name

        String name
        XML Schema元素的名称。

        如果值为“## default”，则元素名称将从JavaBean属性名称派生。

        Default:
        “＃＃默认”

      • nillable

        boolean nillable
        自定义元素声明为nillable。

        如果nillable（）为true，则JavaBean属性将映射到XML Schema nillable元素声明。

        Default:
        假

      • required

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

        如果required（）为true，则Javabean属性将映射到具有minOccurs =“1”的XML模式元素声明。 maxOccurs对于单值属性为“1”，对于多值属性为“无界”。

        如果required（）为false，则Javabean属性将映射到具有minOccurs =“0”的XML Schema元素声明。 maxOccurs对于单值属性为“1”，对于多值属性为“无界”。

        Default:
        假

      • namespace

        String namespace
        XML Schema元素的XML目标命名空间。

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

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

      • defaultValue

        String defaultValue
        该元素的默认值。

        该 

          ''
        被指定为该注释元素的默认值的值被用作穷人替代null以允许实现识别“无默认值”状态。
        Default:
        “\ u0000的”

      • type

        Class type
        Java类被引用。
        Default:
        javax.xml.bind.annotation.XmlElement.DEFAULT.class