aoqi@0: /*
aoqi@0:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.bind;
aoqi@0: 
aoqi@0: import org.xml.sax.ContentHandler;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Unmarshaller implemented as SAX ContentHandler.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Applications can use this interface to use their JAXB provider as a component
aoqi@0:  * in an XML pipeline.  For example:
aoqi@0:  *
aoqi@0:  * <pre>
aoqi@0:  *       JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
aoqi@0:  *
aoqi@0:  *       Unmarshaller unmarshaller = context.createUnmarshaller();
aoqi@0:  *
aoqi@0:  *       UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
aoqi@0:  *
aoqi@0:  *       SAXParserFactory spf = SAXParserFactory.newInstance();
aoqi@0:  *       spf.setNamespaceAware( true );
aoqi@0:  *
aoqi@0:  *       XMLReader xmlReader = spf.newSAXParser().getXMLReader();
aoqi@0:  *       xmlReader.setContentHandler( unmarshallerHandler );
aoqi@0:  *       xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
aoqi@0:  *
aoqi@0:  *       MyObject myObject= (MyObject)unmarshallerHandler.getResult();
aoqi@0:  * </pre>
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This interface is reusable: even if the user fails to unmarshal
aoqi@0:  * an object, s/he can still start a new round of unmarshalling.
aoqi@0:  *
aoqi@0:  * @author <ul><li>Kohsuke KAWAGUCHI, Sun Microsystems, Inc.</li></ul>
aoqi@0:  * @see Unmarshaller#getUnmarshallerHandler()
aoqi@0:  * @since JAXB1.0
aoqi@0:  */
aoqi@0: public interface UnmarshallerHandler extends ContentHandler
aoqi@0: {
aoqi@0:     /**
aoqi@0:      * Obtains the unmarshalled result.
aoqi@0:      *
aoqi@0:      * This method can be called only after this handler
aoqi@0:      * receives the endDocument SAX event.
aoqi@0:      *
aoqi@0:      * @exception IllegalStateException
aoqi@0:      *      if this method is called before this handler
aoqi@0:      *      receives the endDocument event.
aoqi@0:      *
aoqi@0:      * @exception JAXBException
aoqi@0:      *      if there is any unmarshalling error.
aoqi@0:      *      Note that the implementation is allowed to throw SAXException
aoqi@0:      *      during the parsing when it finds an error.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      always return a non-null valid object which was unmarshalled.
aoqi@0:      */
aoqi@0:     Object getResult() throws JAXBException, IllegalStateException;
aoqi@0: }