1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/UnmarshallerHandler.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,83 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package javax.xml.bind;
1.30 +
1.31 +import org.xml.sax.ContentHandler;
1.32 +
1.33 +/**
1.34 + * Unmarshaller implemented as SAX ContentHandler.
1.35 + *
1.36 + * <p>
1.37 + * Applications can use this interface to use their JAXB provider as a component
1.38 + * in an XML pipeline. For example:
1.39 + *
1.40 + * <pre>
1.41 + * JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
1.42 + *
1.43 + * Unmarshaller unmarshaller = context.createUnmarshaller();
1.44 + *
1.45 + * UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
1.46 + *
1.47 + * SAXParserFactory spf = SAXParserFactory.newInstance();
1.48 + * spf.setNamespaceAware( true );
1.49 + *
1.50 + * XMLReader xmlReader = spf.newSAXParser().getXMLReader();
1.51 + * xmlReader.setContentHandler( unmarshallerHandler );
1.52 + * xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
1.53 + *
1.54 + * MyObject myObject= (MyObject)unmarshallerHandler.getResult();
1.55 + * </pre>
1.56 + *
1.57 + * <p>
1.58 + * This interface is reusable: even if the user fails to unmarshal
1.59 + * an object, s/he can still start a new round of unmarshalling.
1.60 + *
1.61 + * @author <ul><li>Kohsuke KAWAGUCHI, Sun Microsystems, Inc.</li></ul>
1.62 + * @see Unmarshaller#getUnmarshallerHandler()
1.63 + * @since JAXB1.0
1.64 + */
1.65 +public interface UnmarshallerHandler extends ContentHandler
1.66 +{
1.67 + /**
1.68 + * Obtains the unmarshalled result.
1.69 + *
1.70 + * This method can be called only after this handler
1.71 + * receives the endDocument SAX event.
1.72 + *
1.73 + * @exception IllegalStateException
1.74 + * if this method is called before this handler
1.75 + * receives the endDocument event.
1.76 + *
1.77 + * @exception JAXBException
1.78 + * if there is any unmarshalling error.
1.79 + * Note that the implementation is allowed to throw SAXException
1.80 + * during the parsing when it finds an error.
1.81 + *
1.82 + * @return
1.83 + * always return a non-null valid object which was unmarshalled.
1.84 + */
1.85 + Object getResult() throws JAXBException, IllegalStateException;
1.86 +}
