Spec-Zone.ru › OpenJDK 8

Тип аннотации XmlAttribute


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

Сопоставляет свойство JavaBean с атрибутом XML.

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

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

  • Свойство JavaBean
  • поле

Статическое конечное поле сопоставляется с фиксированным атрибутом XML.

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

Использование подчиняется следующим ограничениям:
  • Если тип поля или свойства — тип коллекции, то тип элемента коллекции должен быть сопоставлен со схемой простого типа.
    // Examples
         @XmlAttribute List<Integer> items; //legal
         @XmlAttribute List<Bar> foo; // illegal if Bar does not map to a schema simple type
  • Если тип поля или свойства — не тип коллекции, то тип свойства или поля должен быть сопоставлен с простым типом схемы.
    // Examples
         @XmlAttribute int foo; // legal
         @XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type
  • Эта аннотация может быть использована со следующими аннотациями: XmlID, XmlIDREF, XmlList, XmlSchemaType, XmlValue, XmlAttachmentRef, XmlMimeType, XmlInlineBinaryData, XmlJavaTypeAdapter.

Пример 1: Сопоставление свойства JavaBean с атрибутом XML.

//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>

Пример 2: Сопоставление свойства JavaBean с атрибутом XML с анонимным типом.

См. Пример 7 в @XmlType.

Пример 3: Сопоставление свойства JavaBean коллекции с атрибутом XML.

// 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>
С тех пор:
JAXB2.0
См. также:
XmlType

Дополнительные элементы

Модификатор и тип Дополнительный элемент и описание
String name

Имя атрибута XML-схемы.

String namespace

Указывает целевой пространство имен XML атрибута XML-схемы.

boolean required

Указывает, является ли атрибут XML-схемы необязательным или обязательным.

Элементы

name

public abstract String name

Имя атрибута XML-схемы. По умолчанию имя атрибута XML-схемы выводится из имени свойства JavaBean.

По умолчанию:
"##default"

required

public abstract boolean required

Указывает, является ли атрибут XML-схемы необязательным или обязательным. Если true, то свойство JavaBean сопоставляется с атрибутом XML-схемы, который является обязательным. В противном случае он сопоставляется с атрибутом XML-схемы, который является необязательным.

По умолчанию:
false

namespace

public abstract String namespace

Указывает целевое пространство имен атрибута XML-схемы.

По умолчанию:
"##default"

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API