Annotation Type XmlElementDecl

  • @Retention(RUNTIME)
    public @interface XmlElementDecl
    Maps a factory method to a XML element.


    The annotation creates a mapping between an XML schema element declaration and a element factory method that returns a JAXBElement instance representing the element declaration. Typically, the element factory method is generated (and annotated) from a schema into the ObjectFactory class in a Java package that represents the binding of the element declaration's target namespace. Thus, while the annotation syntax allows @XmlElementDecl to be used on any method, semantically its use is restricted to annotation of element factory method. The usage is subject to the following constraints:
    • The class containing the element factory method annotated with @XmlElementDecl must be marked with XmlRegistry.
    • The element factory method must take one parameter assignable to Object.

    Example 1: Annotation on a factory method

         // Example: code fragment
         class ObjectFactory {
             JAXBElement<String> createFoo(String s) { ... }
         <!-- XML input -->
         // Example: code fragment corresponding to XML input
         JAXBElement<String> o =
         // 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"/>

    Example 2: Element declaration with non local scope

    The following example illustrates the use of scope annotation parameter in binding of element declaration in schema derived code.

    The following example may be replaced in a future revision of this javadoc.

         <!-- Example: XML schema definition -->
           <xs:complexType name="pea">
             <xs:choice maxOccurs="unbounded">
               <xs:element name="foo" type="xs:string"/>
               <xs:element name="bar" type="xs:string"/>
           <xs:element name="foo" type="xs:int"/>
         // Example: expected default binding
         class Pea {
             List<JAXBElement<String>> fooOrBar;
         class ObjectFactory {
             JAXBElement<String> createPeaFoo(String s);
             JAXBElement<String> createPeaBar(String s);
             JAXBElement<Integer> createFoo(Integer i);
    Without scope createFoo and createPeaFoo would become ambiguous since both of them map to a XML schema element with the same local name "foo".
    See Also:
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      local name of the XML element.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String defaultValue
      Default value of this element.
      java.lang.String namespace
      namespace name of the XML element.
      java.lang.Class scope
      scope of the mapping.
      java.lang.String substitutionHeadName
      XML local name of a substitution group's head element.
      java.lang.String substitutionHeadNamespace
      namespace name of a substitution group's head XML element.
    • Element Detail

      • name

        java.lang.String name
        local name of the XML element.

        Note to reviewers: There is no default name; since the annotation is on a factory method, it is not clear that the method name can be derived from the factory method name.

        See Also:
      • scope

        java.lang.Class scope
        scope of the mapping.

        If this is not XmlElementDecl.GLOBAL, then this element declaration mapping is only active within the specified class.

      • namespace

        java.lang.String namespace
        namespace name of the XML element.

        If the value is "##default", then the value is the namespace name for the package of the class containing this factory method.

        See Also:
      • substitutionHeadNamespace

        java.lang.String substitutionHeadNamespace
        namespace name of a substitution group's head XML element.

        This specifies the namespace name of the XML element whose local name is specified by substitutionHeadName().

        If susbtitutionHeadName() is "", then this value can only be "##default". But the value is ignored since since this element is not part of susbtitution group when the value of susbstitutionHeadName() is "".

        If susbtitutionHeadName() is not "" and the value is "##default", then the namespace name is the namespace name to which the package of the containing class, marked with XmlRegistry, is mapped.

        If susbtitutionHeadName() is not "" and the value is not "##default", then the value is the namespace name.

        See Also:
      • substitutionHeadName

        java.lang.String substitutionHeadName
        XML local name of a substitution group's head element.

        If the value is "", then this element is not part of any substitution group.

        See Also:
      • defaultValue

        java.lang.String defaultValue
        Default value of this element.


        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.