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