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