Thu, 12 Oct 2017 19:44:07 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2011, 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 com.sun.xml.internal.bind.unmarshaller; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import javax.xml.bind.Binder; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import com.sun.xml.internal.bind.v2.runtime.unmarshaller.LocatorEx; |
aoqi@0 | 31 | |
aoqi@0 | 32 | import org.xml.sax.Attributes; |
aoqi@0 | 33 | import org.xml.sax.ContentHandler; |
aoqi@0 | 34 | import org.xml.sax.SAXException; |
aoqi@0 | 35 | |
aoqi@0 | 36 | /** |
aoqi@0 | 37 | * Visits a DOM-ish API and generates SAX events. |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * <p> |
aoqi@0 | 40 | * This interface is not tied to any particular DOM API. |
aoqi@0 | 41 | * Used by the {@link Binder}. |
aoqi@0 | 42 | * |
aoqi@0 | 43 | * <p> |
aoqi@0 | 44 | * Since we are parsing a DOM-ish tree, I don't think this |
aoqi@0 | 45 | * scanner itself will ever find an error, so this class |
aoqi@0 | 46 | * doesn't have its own error reporting scheme. |
aoqi@0 | 47 | * |
aoqi@0 | 48 | * <p> |
aoqi@0 | 49 | * This interface <b>MAY NOT</b> be implemented by the generated |
aoqi@0 | 50 | * runtime nor the generated code. We may add new methods on |
aoqi@0 | 51 | * this interface later. This is to be implemented by the static runtime |
aoqi@0 | 52 | * only. |
aoqi@0 | 53 | * |
aoqi@0 | 54 | * @author |
aoqi@0 | 55 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
aoqi@0 | 56 | * @since 2.0 |
aoqi@0 | 57 | */ |
aoqi@0 | 58 | public interface InfosetScanner<XmlNode> { |
aoqi@0 | 59 | /** |
aoqi@0 | 60 | * Parses the given DOM-ish element/document and generates |
aoqi@0 | 61 | * SAX events. |
aoqi@0 | 62 | * |
aoqi@0 | 63 | * @throws ClassCastException |
aoqi@0 | 64 | * If the type of the node is not known to this implementation. |
aoqi@0 | 65 | * |
aoqi@0 | 66 | * @throws SAXException |
aoqi@0 | 67 | * If the {@link ContentHandler} throws a {@link SAXException}. |
aoqi@0 | 68 | * Do not throw an exception just because the scanner failed |
aoqi@0 | 69 | * (if that can happen we need to change the API.) |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | void scan( XmlNode node ) throws SAXException; |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Sets the {@link ContentHandler}. |
aoqi@0 | 75 | * |
aoqi@0 | 76 | * This handler receives the SAX events. |
aoqi@0 | 77 | */ |
aoqi@0 | 78 | void setContentHandler( ContentHandler handler ); |
aoqi@0 | 79 | ContentHandler getContentHandler(); |
aoqi@0 | 80 | |
aoqi@0 | 81 | /** |
aoqi@0 | 82 | * Gets the current element we are parsing. |
aoqi@0 | 83 | * |
aoqi@0 | 84 | * <p> |
aoqi@0 | 85 | * This method could |
aoqi@0 | 86 | * be called from the {@link ContentHandler#startElement(String, String, String, Attributes)} |
aoqi@0 | 87 | * or {@link ContentHandler#endElement(String, String, String)}. |
aoqi@0 | 88 | * |
aoqi@0 | 89 | * <p> |
aoqi@0 | 90 | * Otherwise the behavior of this method is undefined. |
aoqi@0 | 91 | * |
aoqi@0 | 92 | * @return |
aoqi@0 | 93 | * never return null. |
aoqi@0 | 94 | */ |
aoqi@0 | 95 | XmlNode getCurrentElement(); |
aoqi@0 | 96 | |
aoqi@0 | 97 | LocatorEx getLocator(); |
aoqi@0 | 98 | } |