spinjar.com.sun.xml.bind.unmarshaller.InfosetScanner Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.bind.unmarshaller;
import javax.xml.bind.Binder;
import com.sun.xml.bind.v2.runtime.unmarshaller.LocatorEx;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
/**
* Visits a DOM-ish API and generates SAX events.
*
*
* This interface is not tied to any particular DOM API.
* Used by the {@link Binder}.
*
*
* Since we are parsing a DOM-ish tree, I don't think this
* scanner itself will ever find an error, so this class
* doesn't have its own error reporting scheme.
*
*
* This interface MAY NOT be implemented by the generated
* runtime nor the generated code. We may add new methods on
* this interface later. This is to be implemented by the static runtime
* only.
*
* @author
* Kohsuke Kawaguchi ([email protected])
* @since 2.0
*/
public interface InfosetScanner {
/**
* Parses the given DOM-ish element/document and generates
* SAX events.
*
* @throws ClassCastException
* If the type of the node is not known to this implementation.
*
* @throws SAXException
* If the {@link ContentHandler} throws a {@link SAXException}.
* Do not throw an exception just because the scanner failed
* (if that can happen we need to change the API.)
*/
void scan( XmlNode node ) throws SAXException;
/**
* Sets the {@link ContentHandler}.
*
* This handler receives the SAX events.
*/
void setContentHandler( ContentHandler handler );
ContentHandler getContentHandler();
/**
* Gets the current element we are parsing.
*
*
* This method could
* be called from the {@link ContentHandler#startElement(String, String, String, Attributes)}
* or {@link ContentHandler#endElement(String, String, String)}.
*
*
* Otherwise the behavior of this method is undefined.
*
* @return
* never return null.
*/
XmlNode getCurrentElement();
LocatorEx getLocator();
}