Usage
+ *+ * @XmlElement annotation can be used with the following program + * elements: + *
+ * + *
+ * A JavaBean property, when annotated with @XmlElement annotation + * is mapped to a local element in the XML Schema complex type to + * which the containing class is mapped. + * + *
+ * Example 1: Map a public non static non final field to local + * element + *
+ * //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>
+ *
+ * + * + * Example 2: Map a field to a nillable element. + *
+ *
+ * //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>
+ *
+ * + * Example 3: Map a field to a nillable, required element. + *
+ *
+ * //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>
+ *
+ * + * + *
Example 4: Map a JavaBean property to an XML element + * with anonymous type.
+ *+ * See Example 6 in @{@link XmlType}. + * + *
+ * @author Sekhar Vajjhala, Sun Microsystems, Inc. + * @since JAXB2.0 + */ + +@Retention(RUNTIME) @Target({FIELD, METHOD, PARAMETER}) +public @interface XmlElement { + /** + * Name of the XML Schema element. + *
If the value is "##default", then element name is derived from the + * JavaBean property name. + */ + String name() default "##default"; + + /** + * Customize the element declaration to be nillable. + *
If nillable() is true, then the JavaBean property is + * mapped to a XML Schema nillable element declaration. + */ + boolean nillable() default false; + + /** + * Customize the element declaration to be required. + *
If required() is true, then Javabean property is mapped to + * an XML schema element declaration with minOccurs="1". + * maxOccurs is "1" for a single valued property and "unbounded" + * for a multivalued property. + *
If required() is false, then the Javabean property is mapped + * to XML Schema element declaration with minOccurs="0". + * maxOccurs is "1" for a single valued property and "unbounded" + * for a multivalued property. + */ + + boolean required() default false; + + /** + * XML target namespace of the XML Schema element. + *
+ * If the value is "##default", then the namespace is determined + * as follows: + *
+ * The
'\u0000'value specified as a default of this annotation element + * is used as a poor-man's substitute for null to allow implementations + * to recognize the 'no default value' state. + */ + String defaultValue() default "\u0000"; + + /** + * The Java class being referenced. + */ + Class type() default DEFAULT.class; + + /** + * Used in {@link XmlElement#type()} to + * signal that the type be inferred from the signature + * of the property. + */ + static final class DEFAULT {} +}