jdk8-mips64-public/jaxws: src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementDecl.java@0989ad8c0860 (annotated)

src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementDecl.java@0989ad8c0860 (annotated)

src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementDecl.java

Tue, 09 Apr 2013 14:51:13 +0100

author: alanb
date: Tue, 09 Apr 2013 14:51:13 +0100
changeset 368: 0989ad8c0860
parent 286: f50545b5e2f1
child 397: b99d7e355d4b
permissions: -rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

 /*
  * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 package javax.xml.bind.annotation;
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 import static java.lang.annotation.ElementType.METHOD;
 /**
  * Maps a factory method to a XML element.
  *
  * <p> <b>Usage</b> </p>
  *
  * The annotation creates a mapping between an XML schema element
  * declaration and a <i> element factory method </i> 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 &#64;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:
  *
  * <ul>
  *   <li> The class containing the element factory method annotated
  *        with &#64;XmlElementDecl must be marked with {@link
  *        XmlRegistry}. </li>
  *   <li> The element factory method must take one parameter
  *        assignable to {@link Object}.</li>
  * </ul>
  *
  * <p><b>Example 1: </b>Annotation on a factory method
  * <pre>
  *     // Example: code fragment
  *     &#64;XmlRegistry
  *     class ObjectFactory {
  *         &#64;XmlElementDecl(name="foo")
  *         JAXBElement&lt;String> createFoo(String s) { ... }
  *     }
  * </pre>
  * <pre>
  *     &lt;!-- XML input -->
  *       &lt;foo>string</foo>
  *
  *     // Example: code fragment corresponding to XML input
  *     JAXBElement<String> o =
  *     (JAXBElement<String>)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"
  *
  *     &lt;!-- Example: XML schema definition -->
  *     &lt;xs:element name="foo" type="xs:string"/>
  * </pre>
  *
  * <p><b>Example 2: </b> Element declaration with non local scope
  * <p>
  * The following example illustrates the use of scope annotation
  * parameter in binding of element declaration in schema derived
  * code.
  * <p>
  * The following example may be replaced in a future revision of
  * this javadoc.
  *
  * <pre>
  *     &lt;!-- Example: XML schema definition -->
  *     &lt;xs:schema>
  *       &lt;xs:complexType name="pea">
  *         &lt;xs:choice maxOccurs="unbounded">
  *           &lt;xs:element name="foo" type="xs:string"/>
  *           &lt;xs:element name="bar" type="xs:string"/>
  *         &lt;/xs:choice>
  *       &lt;/xs:complexType>
  *       &lt;xs:element name="foo" type="xs:int"/>
  *     &lt;/xs:schema>
  * </pre>
  * <pre>
  *     // Example: expected default binding
  *     class Pea {
  *         &#64;XmlElementRefs({
  *             &#64;XmlElementRef(name="foo",type=JAXBElement.class)
  *             &#64;XmlElementRef(name="bar",type=JAXBElement.class)
  *         })
  *         List&lt;JAXBElement&lt;String>> fooOrBar;
  *     }
  *
  *     &#64;XmlRegistry
  *     class ObjectFactory {
  *         &#64;XmlElementDecl(scope=Pea.class,name="foo")
  *         JAXBElement<String> createPeaFoo(String s);
  *
  *         &#64;XmlElementDecl(scope=Pea.class,name="bar")
  *         JAXBElement<String> createPeaBar(String s);
  *
  *         &#64;XmlElementDecl(name="foo")
  *         JAXBElement<Integer> createFoo(Integer i);
  *     }
  *
  * </pre>
  * 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 XmlRegistry
  * @since JAXB 2.0
  */
 @Retention(RUNTIME)
 @Target({METHOD})
 public @interface XmlElementDecl {
     /**
      * scope of the mapping.
      *
      * <p>
      * If this is not {@link XmlElementDecl.GLOBAL}, then this element
      * declaration mapping is only active within the specified class.
      */
     Class scope() default GLOBAL.class;
     /**
      * namespace name of the XML element.
      * <p>
      * If the value is "##default", then the value is the namespace
      * name for the package of the class containing this factory method.
      *
      * @see #name()
      */
     String namespace() default "##default";
     /**
      * local name of the XML element.
      *
      * <p>
      * <b> Note to reviewers: </b> 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 #namespace()
      */
     String name();
     /**
      * namespace name of a substitution group's head XML element.
      * <p>
      * This specifies the namespace name of the XML element whose local
      * name is specified by <tt>substitutionHeadName()</tt>.
      * <p>
      * If <tt>susbtitutionHeadName()</tt> 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 <tt>susbstitutionHeadName()</tt> is "".
      * <p>
      * If <tt>susbtitutionHeadName()</tt> 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 {@link
      * XmlRegistry }, is mapped.
      * <p>
      * If <tt>susbtitutionHeadName()</tt> is not "" and the value is
      * not "##default", then the value is the namespace name.
      *
      * @see #substitutionHeadName()
      */
     String substitutionHeadNamespace() default "##default";
     /**
      * XML local name of a substitution group's head element.
      * <p>
      * If the value is "", then this element is not part of any
      * substitution group.
      *
      * @see #substitutionHeadNamespace()
      */
     String substitutionHeadName() default "";
     /**
      * Default value of this element.
      *
      * <p>
      * The <pre>'\u0000'</pre> 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.
      */
     String defaultValue() default "\u0000";
     /**
      * Used in {@link XmlElementDecl#scope()} to
      * signal that the declaration is in the global scope.
      */
     public final class GLOBAL {}
 }

Mercurial > jdk8-mips64-public > jaxws / annotate

src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementDecl.java@0989ad8c0860 (annotated)

src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementDecl.java