jaxws/src/java.xml.bind/share/classes/javax/xml/bind/Unmarshaller.java
changeset 47210 1edad689f56c
parent 45678 65fdff10664d
--- a/jaxws/src/java.xml.bind/share/classes/javax/xml/bind/Unmarshaller.java	Fri Sep 01 14:13:16 2017 +0000
+++ b/jaxws/src/java.xml.bind/share/classes/javax/xml/bind/Unmarshaller.java	Fri Sep 01 14:06:12 2017 -0700
@@ -186,13 +186,13 @@
  * Unmarshalling can deserialize XML data that represents either an entire XML document
  * or a subtree of an XML document. Typically, it is sufficient to use the
  * unmarshalling methods described by
- * <a href="#unmarshalGlobal">Unmarshal root element that is declared globally</a>.
+ * <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal root element that is declared globally</a>.
  * These unmarshal methods utilize {@link JAXBContext}'s mapping of global XML element
  * declarations and type definitions to JAXB mapped classes to initiate the
  * unmarshalling of the root element of  XML data.  When the {@link JAXBContext}'s
  * mappings are not sufficient to unmarshal the root element of XML data,
  * the application can assist the unmarshalling process by using the
- * <a href="#unmarshalByDeclaredType">unmarshal by declaredType methods</a>.
+ * <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">unmarshal by declaredType methods</a>.
  * These methods are useful for unmarshalling XML data where
  * the root element corresponds to a local element declaration in the schema.
  * </blockquote>
@@ -245,32 +245,29 @@
  * instance are set.
  *
  * <a name="unmarshalDeclaredTypeReturn"></a>
- *   <table summary="" border="2" rules="all" cellpadding="4">
+ *   <table class="striped">
+ *   <caption>Unmarshal By Declared Type returned JAXBElement</caption>
  *   <thead>
  *     <tr>
- *       <th align="center" colspan="2">
- *       Unmarshal By Declared Type returned JAXBElement
- *       </tr>
- *     <tr>
- *       <th>JAXBElement Property</th>
- *       <th>Value</th>
+ *       <th scope="col">JAXBElement Property</th>
+ *       <th scope="col">Value</th>
  *     </tr>
  *     <tr>
- *       <td>name</td>
- *       <td>{@code xml element name}</td>
+ *       <th scope="col">name</th>
+ *       <th scope="col">{@code xml element name}</th>
  *     </tr>
  *   </thead>
  *   <tbody>
  *     <tr>
- *       <td>value</td>
+ *       <th scope="row">value</th>
  *       <td>{@code instanceof declaredType}</td>
  *     </tr>
  *     <tr>
- *       <td>declaredType</td>
+ *       <th scope="row">declaredType</th>
  *       <td>unmarshal method {@code declaredType} parameter</td>
  *     </tr>
  *     <tr>
- *       <td>scope</td>
+ *       <th scope="row">scope</th>
  *       <td>{@code null} <i>(actual scope is unknown)</i></td>
  *     </tr>
  *   </tbody>
@@ -279,7 +276,7 @@
  *
  * <p>
  * The following is an example of
- * <a href="#unmarshalByDeclaredType">unmarshal by declaredType method</a>.
+ * <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">unmarshal by declaredType method</a>.
  * <p>
  * Unmarshal by declaredType from a {@code org.w3c.dom.Node}:
  * <blockquote>
@@ -414,7 +411,7 @@
      * content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param f the file to unmarshal XML data from
      * @return the newly created root object of the java content tree
@@ -425,7 +422,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the file parameter is null
      */
@@ -437,7 +434,7 @@
      * be incomplete when using this form of the unmarshal API.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param is the InputStream to unmarshal XML data from
      * @return the newly created root object of the java content tree
@@ -448,7 +445,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the InputStream parameter is null
      */
@@ -461,7 +458,7 @@
      * because a Reader does not provide the system ID.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param reader the Reader to unmarshal XML data from
      * @return the newly created root object of the java content tree
@@ -472,7 +469,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the InputStream parameter is null
      * @since 1.6, JAXB 2.0
@@ -484,7 +481,7 @@
      * content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param url the url to unmarshal XML data from
      * @return the newly created root object of the java content tree
@@ -495,7 +492,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the URL parameter is null
      */
@@ -506,7 +503,7 @@
      * resulting content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param source the input source to unmarshal XML data from
      * @return the newly created root object of the java content tree
@@ -517,7 +514,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the InputSource parameter is null
      */
@@ -528,7 +525,7 @@
      * content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * @param node
      *      the document/element to unmarshal XML data from.
@@ -541,7 +538,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the Node parameter is null
      * @see #unmarshal(org.w3c.dom.Node, Class)
@@ -553,7 +550,7 @@
      * and return the resulting content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalByDeclaredType">Unmarshal by Declared Type</a>
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">Unmarshal by Declared Type</a>
      *
      * @param node
      *      the document/element to unmarshal XML data from.
@@ -561,7 +558,7 @@
      * @param declaredType
      *      appropriate JAXB mapped class to hold {@code node}'s XML data.
      *
-     * @return <a href="#unmarshalDeclaredTypeReturn">JAXB Element</a> representation of {@code node}
+     * @return <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalDeclaredTypeReturn">JAXB Element</a> representation of {@code node}
      *
      * @throws JAXBException
      *     If any unexpected errors occur while unmarshalling
@@ -569,7 +566,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If any parameter is null
      * @since 1.6, JAXB 2.0
@@ -581,7 +578,7 @@
      * resulting content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * <p>
      * <a name="saxParserPlugable"></a>
@@ -627,7 +624,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the Source parameter is null
      * @see #unmarshal(javax.xml.transform.Source, Class)
@@ -641,16 +638,16 @@
      * resulting content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalByDeclaredType">Unmarshal by Declared Type</a>
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">Unmarshal by Declared Type</a>
      *
      * <p>
-     * See <a href="#saxParserPlugable">SAX 2.0 Parser Pluggability</a>
+     * See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#saxParserPlugable">SAX 2.0 Parser Pluggability</a>
      *
      * @param source the XML Source to unmarshal XML data from (providers are
      *        only required to support SAXSource, DOMSource, and StreamSource)
      * @param declaredType
      *      appropriate JAXB mapped class to hold {@code source}'s xml root element
-     * @return Java content rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element</a>
+     * @return Java content rooted by <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalDeclaredTypeReturn">JAXB Element</a>
      *
      * @throws JAXBException
      *     If any unexpected errors occur while unmarshalling
@@ -658,7 +655,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If any parameter is null
      * @since 1.6, JAXB 2.0
@@ -671,7 +668,7 @@
      * resulting content tree.
      *
      * <p>
-     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
+     * Implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root Element</a>.
      *
      * <p>
      * This method assumes that the parser is on a START_DOCUMENT or
@@ -691,7 +688,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the {@code reader} parameter is null
      * @throws IllegalStateException
@@ -708,7 +705,7 @@
      * and return the resulting content tree.
      *
      * <p>
-     * This method implements <a href="#unmarshalByDeclaredType">unmarshal by declaredType</a>.
+     * This method implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">unmarshal by declaredType</a>.
      * <p>
      * This method assumes that the parser is on a START_DOCUMENT or
      * START_ELEMENT event. Unmarshalling will be done from this
@@ -721,7 +718,7 @@
      * @param declaredType
      *      appropriate JAXB mapped class to hold {@code reader}'s START_ELEMENT XML data.
      *
-     * @return   content tree rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element representation</a>
+     * @return   content tree rooted by <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalDeclaredTypeReturn">JAXB Element representation</a>
      *
      * @throws JAXBException
      *     If any unexpected errors occur while unmarshalling
@@ -729,7 +726,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If any parameter is null
      * @since 1.6, JAXB 2.0
@@ -741,7 +738,7 @@
      * resulting content tree.
      *
      * <p>
-     * This method is an <a href="#unmarshalGlobal">Unmarshal Global Root method</a>.
+     * This method is an <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalGlobal">Unmarshal Global Root method</a>.
      *
      * <p>
      * This method assumes that the parser is on a START_DOCUMENT or
@@ -761,7 +758,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If the {@code reader} parameter is null
      * @throws IllegalStateException
@@ -778,7 +775,7 @@
      * and return the resulting content tree.
      *
      * <p>
-     * This method implements <a href="#unmarshalByDeclaredType">unmarshal by declaredType</a>.
+     * This method implements <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalByDeclaredType">unmarshal by declaredType</a>.
      *
      * <p>
      * This method assumes that the parser is on a START_DOCUMENT or
@@ -792,7 +789,7 @@
      * @param declaredType
      *      appropriate JAXB mapped class to hold {@code reader}'s START_ELEMENT XML data.
      *
-     * @return   content tree rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element representation</a>
+     * @return   content tree rooted by <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalDeclaredTypeReturn">JAXB Element representation</a>
      *
      * @throws JAXBException
      *     If any unexpected errors occur while unmarshalling
@@ -800,7 +797,7 @@
      *     If the {@link ValidationEventHandler ValidationEventHandler}
      *     returns false from its {@code handleEvent} method or the
      *     {@code Unmarshaller} is unable to perform the XML to Java
-     *     binding.  See <a href="#unmarshalEx">Unmarshalling XML Data</a>
+     *     binding.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#unmarshalEx">Unmarshalling XML Data</a>
      * @throws IllegalArgumentException
      *      If any parameter is null
      * @since 1.6, JAXB 2.0
@@ -913,7 +910,7 @@
      * {@code Unmarshaller}.  This method can only be used to set one of
      * the standard JAXB defined properties above or a provider specific
      * property.  Attempting to set an undefined property will result in
-     * a PropertyException being thrown.  See <a href="#supportedProps">
+     * a PropertyException being thrown.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#supportedProps">
      * Supported Properties</a>.
      *
      * @param name the name of the property to be set. This value can either
@@ -934,7 +931,7 @@
      * {@code Unmarshaller}.  This method can only be used to get one of
      * the standard JAXB defined properties above or a provider specific
      * property.  Attempting to get an undefined property will result in
-     * a PropertyException being thrown.  See <a href="#supportedProps">
+     * a PropertyException being thrown.  See <a href="{@docRoot}/javax/xml/bind/Unmarshaller.html#supportedProps">
      * Supported Properties</a>.
      *
      * @param name the name of the property to retrieve