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

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

@Retention(value=RUNTIME)
@Target(value={FIELD,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 позволяют нулевому набору быть представленным или отсутствием или присутствием элемента со способным иметь значение NULL атрибутом.

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

Аннотация @XmlElementWrapper может использоваться со следующими элементами программы:

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

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

• Свойство должно быть свойством набора
• Эта аннотация может использоваться со следующими аннотациями: XmlElement, XmlElements, XmlElementRef, XmlElementRefs, XmlJavaTypeAdapter
.

См. "Спецификацию Пакета" в javax.xml.bind.package javadoc для дополнительной общей информации.

С тех пор:

JAXB2.0

Автор:

• Kohsuke Кавагути, Sun Microsystems, Inc.
• Sekhar Vajjhala, Sun Microsystems, Inc.

См. Также:

XmlElement, XmlElements, XmlElementRef, XmlElementRefs

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

java.lang.String	имя Имя элемента обертки XML.
java.lang.String	пространство имен XML предназначаются для пространства имен элемента обертки XML.
boolean	способный иметь значение NULL Если это правда, отсутствие набора представляется при использовании xsi:nil='true'.
boolean	необходимый Настройте объявление элемента обертки, которое будет требоваться.

имя

public abstract java.lang.String name

Имя элемента обертки XML. По умолчанию имя элемента обертки XML получается из имени свойства JavaBean.

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

"##default"

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

public abstract java.lang.String namespace

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

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

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

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

"##default"

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

public abstract boolean nillable

Если это правда, отсутствие набора представляется при использовании xsi:nil='true'. Иначе, это представляется отсутствием элемента.

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

ложь

необходимый

public abstract boolean required

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

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

Отметьте, что это только влияет на генерацию схемы, а не немаршалинг или маршалинг возможности. Это - просто механизм, чтобы позволить пользователям выражать свои ограничения приложения лучше.

С тех пор:

JAXB 2.1

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

ложь