src/share/jaxws_classes/javax/xml/bind/JAXBIntrospector.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 397
b99d7e355d4b
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
mkos@397 2 * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind;
ohair@286 27 import javax.xml.namespace.QName;
ohair@286 28
ohair@286 29 /**
ohair@286 30 * Provide access to JAXB xml binding data for a JAXB object.
ohair@286 31 *
ohair@286 32 * <p>
ohair@286 33 * Intially, the intent of this class is to just conceptualize how
ohair@286 34 * a JAXB application developer can access xml binding information,
ohair@286 35 * independent if binding model is java to schema or schema to java.
ohair@286 36 * Since accessing the XML element name related to a JAXB element is
ohair@286 37 * a highly requested feature, demonstrate access to this
ohair@286 38 * binding information.
ohair@286 39 *
ohair@286 40 * The factory method to get a <code>JAXBIntrospector</code> instance is
ohair@286 41 * {@link JAXBContext#createJAXBIntrospector()}.
ohair@286 42 *
ohair@286 43 * @see JAXBContext#createJAXBIntrospector()
ohair@286 44 * @since JAXB2.0
ohair@286 45 */
ohair@286 46 public abstract class JAXBIntrospector {
ohair@286 47
ohair@286 48 /**
alanb@368 49 * <p>Return true if <code>object</code> represents a JAXB element.</p>
ohair@286 50 * <p>Parameter <code>object</code> is a JAXB element for following cases:
ohair@286 51 * <ol>
ohair@286 52 * <li>It is an instance of <code>javax.xml.bind.JAXBElement</code>.</li>
ohair@286 53 * <li>The class of <code>object</code> is annotated with
ohair@286 54 * <code>&#64XmlRootElement</code>.
ohair@286 55 * </li>
ohair@286 56 * </ol>
ohair@286 57 *
ohair@286 58 * @see #getElementName(Object)
ohair@286 59 */
ohair@286 60 public abstract boolean isElement(Object object);
ohair@286 61
ohair@286 62 /**
ohair@286 63 * <p>Get xml element qname for <code>jaxbElement</code>.</p>
ohair@286 64 *
ohair@286 65 * @param jaxbElement is an object that {@link #isElement(Object)} returned true.
ohair@286 66 *
ohair@286 67 * @return xml element qname associated with jaxbElement;
ohair@286 68 * null if <code>jaxbElement</code> is not a JAXB Element.
ohair@286 69 */
ohair@286 70 public abstract QName getElementName(Object jaxbElement);
ohair@286 71
ohair@286 72 /**
ohair@286 73 * <p>Get the element value of a JAXB element.</p>
ohair@286 74 *
ohair@286 75 * <p>Convenience method to abstract whether working with either
ohair@286 76 * a javax.xml.bind.JAXBElement instance or an instance of
ohair@286 77 * <tt>&#64XmlRootElement</tt> annotated Java class.</p>
ohair@286 78 *
ohair@286 79 * @param jaxbElement object that #isElement(Object) returns true.
ohair@286 80 *
ohair@286 81 * @return The element value of the <code>jaxbElement</code>.
ohair@286 82 */
ohair@286 83 public static Object getValue(Object jaxbElement) {
ohair@286 84 if (jaxbElement instanceof JAXBElement) {
ohair@286 85 return ((JAXBElement)jaxbElement).getValue();
ohair@286 86 } else {
ohair@286 87 // assume that class of this instance is
ohair@286 88 // annotated with @XmlRootElement.
ohair@286 89 return jaxbElement;
ohair@286 90 }
ohair@286 91 }
ohair@286 92 }

mercurial