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