javax.xml.bind.JAXBIntrospector Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.bind;
import javax.xml.namespace.QName;
/**
* Provide access to JAXB xml binding data for a JAXB object.
*
*
* Intially, the intent of this class is to just conceptualize how
* a JAXB application developer can access xml binding information,
* independent if binding model is java to schema or schema to java.
* Since accessing the XML element name related to a JAXB element is
* a highly requested feature, demonstrate access to this
* binding information.
*
* The factory method to get a JAXBIntrospector instance is
* {@link JAXBContext#createJAXBIntrospector()}.
*
* @see JAXBContext#createJAXBIntrospector()
* @since 1.6, JAXB 2.0
*/
public abstract class JAXBIntrospector {
/**
*
Return true if object represents a JAXB element.
* Parameter object is a JAXB element for following cases:
*
* - It is an instance of
javax.xml.bind.JAXBElement.
* - The class of
object is annotated with
* @XmlRootElement.
*
*
*
* @see #getElementName(Object)
*/
public abstract boolean isElement(Object object);
/**
* Get xml element qname for jaxbElement.
*
* @param jaxbElement is an object that {@link #isElement(Object)} returned true.
*
* @return xml element qname associated with jaxbElement;
* null if jaxbElement is not a JAXB Element.
*/
public abstract QName getElementName(Object jaxbElement);
/**
* Get the element value of a JAXB element.
*
* Convenience method to abstract whether working with either
* a javax.xml.bind.JAXBElement instance or an instance of
* @XmlRootElement annotated Java class.
*
* @param jaxbElement object that #isElement(Object) returns true.
*
* @return The element value of the jaxbElement.
*/
public static Object getValue(Object jaxbElement) {
if (jaxbElement instanceof JAXBElement) {
return ((JAXBElement)jaxbElement).getValue();
} else {
// assume that class of this instance is
// annotated with @XmlRootElement.
return jaxbElement;
}
}
}