Spec-Zone .ru спецификации, руководства, описания, API

javax.xml.bind.annotation
Тип аннотации XmlElement

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,PARAMETER})
public @interface XmlElement

Отображает свойство JavaBean на элемент XML, полученный из имени свойства.

Использование

@XmlElement annotation can be used with the following program elements:

свойство JavaBean

не статичный, не переходное поле

в пределах XmlElements

Использование подвергается следующим ограничениям:

• Эта аннотация может использоваться со следующими аннотациями: XmlID, XmlIDREF, XmlList, XmlSchemaType, XmlValue, XmlAttachmentRef, XmlMimeType, XmlInlineBinaryData, XmlElementWrapper, XmlJavaTypeAdapter
• если тип свойства JavaBean является типом набора массива, индексируемого свойства, или параметризованного списка, и эта аннотация используется с XmlElements тогда, @XmlElement.type() должно быть Значение по умолчанию class, так как тип изделия набора уже известен.

Свойство JavaBean, когда аннотирующийся @XmlElement аннотацией отображается на локальный элемент в составном типе XML-схемы, на который отображается содержание class.

Пример 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: Отобразите поле на способный иметь значение NULL элемент.

     //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: Отобразите поле на способный иметь значение NULL, необходимый элемент.

     //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: свойство Map a JavaBean к элементу XML с анонимным типом.

См. Пример 6 вXmlType.

С тех пор:

JAXB2.0

Автор:

Sekhar Vajjhala, Sun Microsystems, Inc.

Дополнительная Сводка Элемента

java.lang.String	defaultValue Значение по умолчанию этого элемента.
java.lang.String	имя Имя элемента XML-схемы.
java.lang.String	пространство имен XML предназначаются для пространства имен элемента XML-схемы.
boolean	способный иметь значение NULL Настройте объявление элемента, чтобы быть способными иметь значение NULL.
boolean	необходимый Настройте объявление элемента, которое будет требоваться.
java.lang.Class	ввести Java ссылаемый class.

имя

public abstract java.lang.String name

Имя элемента XML-схемы.

Если значение "##default", то имя элемента получается из имени свойства JavaBean.

Значение по умолчанию:

"##default"

способный иметь значение NULL

public abstract boolean nillable

Настройте объявление элемента, чтобы быть способными иметь значение NULL.

Если способный иметь значение NULL () истина, то свойство JavaBean отображается на XML-схему способное иметь значение NULL объявление элемента.

Значение по умолчанию:

ложь

необходимый

public abstract boolean required

Настройте объявление элемента, которое будет требоваться.

Если требующийся () истина, то свойство Javabean отображается на объявление элемента XML-схемы с minOccurs = "1". maxOccurs "1" для единственного свойства, передаваемого по значению, и "неограничен" для многозначного свойства.

Если требующийся () ложь, то свойство Javabean отображается на объявление элемента XML-схемы с minOccurs = "0". maxOccurs "1" для единственного свойства, передаваемого по значению, и "неограничен" для многозначного свойства.

Значение по умолчанию:

ложь

пространство имен

public abstract java.lang.String namespace

XML предназначаются для пространства имен элемента XML-схемы.

Если значение "##default", то пространство имен определяется следующим образом:

1. Если пакет включения имеет XmlSchema аннотация, и elementFormDefault QUALIFIED, тогда пространство имен включения class.
2. Иначе "" (который производит неполный элемент в пространстве имен по умолчанию.

Значение по умолчанию:

"##default"

defaultValue

public abstract java.lang.String defaultValue

Значение по умолчанию этого элемента.

'