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