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

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface XmlElementDecl

Сопоставляет метод фабрики с XML-элементом.

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

Аннотация создает сопоставление между объявлением элемента XML-схемы и методом фабрики элемента, возвращающим экземпляр JAXBElement, представляющий объявление элемента. Как правило, метод фабрики элемента генерируется (и аннотируется) из схемы в класс ObjectFactory в пакете Java, который представляет привязку целевого пространства имен объявления элемента. Таким образом, хотя синтаксис аннотации позволяет использовать @XmlElementDecl для любого метода, семантически его использование ограничено аннотацией метода фабрики элемента. Использование подчиняется следующим ограничениям:

• Класс, содержащий метод фабрики элемента, аннотированный с помощью @XmlElementDecl, должен быть помечен с помощью XmlRegistry.
• Метод фабрики элемента должен принимать один параметр, приводимый к Object.

Пример 1: Аннотация на методе фабрики

// Example: code fragment
     @XmlRegistry
     class ObjectFactory {
         @XmlElementDecl(name="foo")
         JAXBElement<String> createFoo(String s) { ... }
     }

<!-- XML input -->
       <foo>string

     // Example: code fragment corresponding to XML input
     JAXBElement o =
     (JAXBElement)unmarshaller.unmarshal(aboveDocument);
     // print JAXBElement instance to show values
     System.out.println(o.getName());   // prints  "{}foo"
     System.out.println(o.getValue());  // prints  "string"
     System.out.println(o.getValue().getClass()); // prints "java.lang.String"

     <!-- Example: XML schema definition -->
     <xs:element name="foo" type="xs:string"/>

Пример 2: Объявление элемента с областью действия, отличной от локальной

Следующий пример иллюстрирует использование параметра аннотации области действия при привязке объявления элемента в коде, полученном из схемы.

Следующий пример может быть заменен в будущих версиях этой документации.

<!-- Example: XML schema definition -->
     <xs:schema>
       <xs:complexType name="pea">
         <xs:choice maxOccurs="unbounded">
           <xs:element name="foo" type="xs:string"/>
           <xs:element name="bar" type="xs:string"/>
         </xs:choice>
       </xs:complexType>
       <xs:element name="foo" type="xs:int"/>
     </xs:schema>

// Example: expected default binding
     class Pea {
         @XmlElementRefs({
             @XmlElementRef(name="foo",type=JAXBElement.class)
             @XmlElementRef(name="bar",type=JAXBElement.class)
         })
         List<JAXBElement<String>> fooOrBar;
     }

     @XmlRegistry
     class ObjectFactory {
         @XmlElementDecl(scope=Pea.class,name="foo")
         JAXBElement createPeaFoo(String s);

         @XmlElementDecl(scope=Pea.class,name="bar")
         JAXBElement createPeaBar(String s);

         @XmlElementDecl(name="foo")
         JAXBElement createFoo(Integer i);
     }

Без области действия createFoo и createPeaFoo станут неоднозначными, так как оба они сопоставляются с элементом XML-схемы с тем же локальным именем «foo».

Элементы

name

public abstract String name

См. также:

namespace()

scope

public abstract Class scope

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

javax.xml.bind.annotation.XmlElementDecl.GLOBAL.class

namespace

public abstract String namespace

См. также:

name()

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

«##default»

substitutionHeadNamespace

public abstract String substitutionHeadNamespace

См. также:

substitutionHeadName()

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

«##default»

substitutionHeadName

public abstract String substitutionHeadName

См. также:

substitutionHeadNamespace()

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

«»

defaultValue

public abstract String defaultValue

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

«\u0000»