1 /*
2 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package javax.xml.bind;
26
27 import org.xml.sax.ContentHandler;
28
29 /**
30 * Unmarshaller implemented as SAX ContentHandler.
31 *
32 * <p>
33 * Applications can use this interface to use their JAXB provider as a component
34 * in an XML pipeline. For example:
35 *
36 * <pre>
37 * JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
38 *
39 * Unmarshaller unmarshaller = context.createUnmarshaller();
40 *
41 * UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
42 *
43 * SAXParserFactory spf = SAXParserFactory.newInstance();
44 * spf.setNamespaceAware( true );
45 *
46 * XMLReader xmlReader = spf.newSAXParser().getXMLReader();
47 * xmlReader.setContentHandler( unmarshallerHandler );
48 * xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
49 *
50 * MyObject myObject= (MyObject)unmarshallerHandler.getResult();
51 * </pre>
52 *
53 * <p>
54 * This interface is reusable: even if the user fails to unmarshal
55 * an object, s/he can still start a new round of unmarshalling.
56 *
57 * @author <ul><li>Kohsuke KAWAGUCHI, Sun Microsystems, Inc.</li></ul>
58 * @see Unmarshaller#getUnmarshallerHandler()
59 * @since JAXB1.0
60 */
61 public interface UnmarshallerHandler extends ContentHandler
62 {
63 /**
64 * Obtains the unmarshalled result.
65 *
66 * This method can be called only after this handler
67 * receives the endDocument SAX event.
68 *
69 * @exception IllegalStateException
70 * if this method is called before this handler
71 * receives the endDocument event.
72 *
73 * @exception JAXBException
74 * if there is any unmarshalling error.
75 * Note that the implementation is allowed to throw SAXException
76 * during the parsing when it finds an error.
77 *
78 * @return
79 * always return a non-null valid object which was unmarshalled.
80 */
81 Object getResult() throws JAXBException, IllegalStateException;
82 }
Save This Page