src/share/jaxws_classes/javax/xml/bind/UnmarshallerHandler.java

Mon, 13 Jan 2014 16:17:43 +0000

author
alanb
date
Mon, 13 Jan 2014 16:17:43 +0000
changeset 449
bd943bdbce05
parent 397
b99d7e355d4b
child 637
9c07ef4934dd
permissions
-rw-r--r--

8027908: serialVersionUID of javax.xml.bind.TypeConstraintException accidently changed
Reviewed-by: alanb
Contributed-by: iaroslav.savytskyi@oracle.com

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

mercurial