You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
99 lines
3.8 KiB
99 lines
3.8 KiB
5 years ago
|
/*
|
||
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
||
|
|
*
|
||
|
|
* Copyright (c) 2003-2017 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
|
||
|
|
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
|
||
|
|
* or 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 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 org.xml.sax.ContentHandler;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Unmarshaller implemented as SAX ContentHandler.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* Applications can use this interface to use their JAXB provider as a component
|
||
|
|
* in an XML pipeline. For example:
|
||
|
|
*
|
||
|
|
* <pre>
|
||
|
|
* JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
|
||
|
|
*
|
||
|
|
* Unmarshaller unmarshaller = context.createUnmarshaller();
|
||
|
|
*
|
||
|
|
* UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
|
||
|
|
*
|
||
|
|
* SAXParserFactory spf = SAXParserFactory.newInstance();
|
||
|
|
* spf.setNamespaceAware( true );
|
||
|
|
*
|
||
|
|
* XMLReader xmlReader = spf.newSAXParser().getXMLReader();
|
||
|
|
* xmlReader.setContentHandler( unmarshallerHandler );
|
||
|
|
* xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
|
||
|
|
*
|
||
|
|
* MyObject myObject= (MyObject)unmarshallerHandler.getResult();
|
||
|
|
* </pre>
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* This interface is reusable: even if the user fails to unmarshal
|
||
|
|
* an object, s/he can still start a new round of unmarshalling.
|
||
|
|
*
|
||
|
|
* @author <ul><li>Kohsuke KAWAGUCHI, Sun Microsystems, Inc.</li></ul>
|
||
|
|
* @see Unmarshaller#getUnmarshallerHandler()
|
||
|
|
* @since 1.6, JAXB 1.0
|
||
|
|
*/
|
||
|
|
public interface UnmarshallerHandler extends ContentHandler
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Obtains the unmarshalled result.
|
||
|
|
*
|
||
|
|
* This method can be called only after this handler
|
||
|
|
* receives the endDocument SAX event.
|
||
|
|
*
|
||
|
|
* @exception IllegalStateException
|
||
|
|
* if this method is called before this handler
|
||
|
|
* receives the endDocument event.
|
||
|
|
*
|
||
|
|
* @exception JAXBException
|
||
|
|
* if there is any unmarshalling error.
|
||
|
|
* Note that the implementation is allowed to throw SAXException
|
||
|
|
* during the parsing when it finds an error.
|
||
|
|
*
|
||
|
|
* @return
|
||
|
|
* always return a non-null valid object which was unmarshalled.
|
||
|
|
*/
|
||
|
|
Object getResult() throws JAXBException, IllegalStateException;
|
||
|
|
}
|