/*
 * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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 JAXBContext.createJAXBIntrospector().

See Also:
Since:1.6, JAXB 2.0
/** * Provide access to JAXB xml binding data for a JAXB object. * * <p> * 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 <code>JAXBIntrospector</code> 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:

  1. It is an instance of javax.xml.bind.JAXBElement.
  2. The class of object is annotated with @XmlRootElement.
See Also:
  • getElementName(Object)
/** * <p>Return true if <code>object</code> represents a JAXB element.</p> * <p>Parameter <code>object</code> is a JAXB element for following cases: * <ol> * <li>It is an instance of <code>javax.xml.bind.JAXBElement</code>.</li> * <li>The class of <code>object</code> is annotated with * <code>&#64;XmlRootElement</code>. * </li> * </ol> * * @see #getElementName(Object) */
public abstract boolean isElement(Object object);

Get xml element qname for jaxbElement.

Params:
Returns:xml element qname associated with jaxbElement; null if jaxbElement is not a JAXB Element.
/** * <p>Get xml element qname for <code>jaxbElement</code>.</p> * * @param jaxbElement is an object that {@link #isElement(Object)} returned true. * * @return xml element qname associated with jaxbElement; * null if <code>jaxbElement</code> 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.

Params:
  • jaxbElement – object that #isElement(Object) returns true.
Returns:The element value of the jaxbElement.
/** * <p>Get the element value of a JAXB element.</p> * * <p>Convenience method to abstract whether working with either * a javax.xml.bind.JAXBElement instance or an instance of * {@code @XmlRootElement} annotated Java class.</p> * * @param jaxbElement object that #isElement(Object) returns true. * * @return The element value of the <code>jaxbElement</code>. */
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; } } }