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

Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:


  24  */
  25 
  26 package javax.xml.bind;
  27 import  javax.xml.namespace.QName;
  28 
  29 /**
  30  * Provide access to JAXB xml binding data for a JAXB object.
  31  *
  32  * <p>
  33  * Intially, the intent of this class is to just conceptualize how
  34  * a JAXB application developer can access xml binding information,
  35  * independent if binding model is java to schema or schema to java.
  36  * Since accessing the XML element name related to a JAXB element is
  37  * a highly requested feature, demonstrate access to this
  38  * binding information.
  39  *
  40  * The factory method to get a <code>JAXBIntrospector</code> instance is
  41  * {@link JAXBContext#createJAXBIntrospector()}.
  42  *
  43  * @see JAXBContext#createJAXBIntrospector()
  44  * @since JAXB2.0
  45  */
  46 public abstract class JAXBIntrospector {
  47 
  48     /**
  49      * <p>Return true if <code>object</code> represents a JAXB element.</p>
  50      * <p>Parameter <code>object</code> is a JAXB element for following cases:
  51      * <ol>
  52      *   <li>It is an instance of <code>javax.xml.bind.JAXBElement</code>.</li>
  53      *   <li>The class of <code>object</code> is annotated with
  54      *       <code>&#64XmlRootElement</code>.
  55      *   </li>
  56      * </ol>
  57      *
  58      * @see #getElementName(Object)
  59      */
  60     public abstract boolean isElement(Object object);
  61 
  62     /**
  63      * <p>Get xml element qname for <code>jaxbElement</code>.</p>
  64      *




  24  */
  25 
  26 package javax.xml.bind;
  27 import  javax.xml.namespace.QName;
  28 
  29 /**
  30  * Provide access to JAXB xml binding data for a JAXB object.
  31  *
  32  * <p>
  33  * Intially, the intent of this class is to just conceptualize how
  34  * a JAXB application developer can access xml binding information,
  35  * independent if binding model is java to schema or schema to java.
  36  * Since accessing the XML element name related to a JAXB element is
  37  * a highly requested feature, demonstrate access to this
  38  * binding information.
  39  *
  40  * The factory method to get a <code>JAXBIntrospector</code> instance is
  41  * {@link JAXBContext#createJAXBIntrospector()}.
  42  *
  43  * @see JAXBContext#createJAXBIntrospector()
  44  * @since 1.6, JAXB 2.0
  45  */
  46 public abstract class JAXBIntrospector {
  47 
  48     /**
  49      * <p>Return true if <code>object</code> represents a JAXB element.</p>
  50      * <p>Parameter <code>object</code> is a JAXB element for following cases:
  51      * <ol>
  52      *   <li>It is an instance of <code>javax.xml.bind.JAXBElement</code>.</li>
  53      *   <li>The class of <code>object</code> is annotated with
  54      *       <code>&#64XmlRootElement</code>.
  55      *   </li>
  56      * </ol>
  57      *
  58      * @see #getElementName(Object)
  59      */
  60     public abstract boolean isElement(Object object);
  61 
  62     /**
  63      * <p>Get xml element qname for <code>jaxbElement</code>.</p>
  64      *