Save This Page
Home » xml-commons-external-1.4.01-src » javax » xml » bind » annotation » [javadoc | source]
javax.xml.bind.annotation
public class: XmlAttribute [javadoc | source]
javax.xml.bind.annotation.XmlAttribute

Maps a JavaBean property to a XML attribute.

Usage

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

A static final field is mapped to a XML fixed attribute.

See "Package Specification" in javax.xml.bind.package javadoc for additional common information.

The usage is subject to the following constraints:

Example 1: Map a JavaBean property to an XML attribute.

    //Example: Code fragment
    public class USPrice {
        @XmlAttribute
        public java.math.BigDecimal getPrice() {...} ;
        public void setPrice(java.math.BigDecimal ) {...};
    }

    <!-- Example: XML Schema fragment -->
    <xs:complexType name="USPrice">
      <xs:sequence>
      </xs:sequence>
      <xs:attribute name="price" type="xs:decimal"/>
    </xs:complexType>

Example 2: Map a JavaBean property to an XML attribute with anonymous type.

See Example 7 in @XmlType .

Example 3: Map a JavaBean collection property to an XML attribute.

    // Example: Code fragment
    class Foo {
        ...
        @XmlAttribute List<Integer> items;
    }

    <!-- Example: XML Schema fragment -->
    <xs:complexType name="foo">
      ...
      <xs:attribute name="items">
        <xs:simpleType>
          <xs:list itemType="xs:int"/>
        </xs:simpleType>
    </xs:complexType>

Method from javax.xml.bind.annotation.XmlAttribute Summary:
name,   namespace,   required
Method from javax.xml.bind.annotation.XmlAttribute Detail:
 String name() 
    Name of the XML Schema attribute. By default, the XML Schema attribute name is derived from the JavaBean property name.
 String namespace() 
    Specifies the XML target namespace of the XML Schema attribute.
 boolean required() 
    Specifies if the XML Schema attribute is optional or required. If true, then the JavaBean property is mapped to a XML Schema attribute that is required. Otherwise it is mapped to a XML Schema attribute that is optional.