org.htmlunit.cyberneko.xerces.xni.parser.XMLDocumentScanner Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017-2024 Ronald Brill
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.htmlunit.cyberneko.xerces.xni.parser;

import java.io.IOException;

import org.htmlunit.cyberneko.xerces.xni.XNIException;

/**
 * This interface defines a generic document scanner. This interface allows a
 * scanner to be used interchangably in existing parser configurations.
 * 
 * If the parser configuration uses a document scanner that implements this
 * interface, components should be able to query the scanner instance from the
 * component manager using the following property identifier: 

 * "http://apache.org/xml/properties/internal/document-scanner" 
 *
 * @author Andy Clark, IBM
 */
public interface XMLDocumentScanner extends XMLDocumentSource {

    /**
     * Sets the input source.
     *
     * @param inputSource The input source.
     *
     * @throws IOException Thrown on i/o error.
     */
    void setInputSource(XMLInputSource inputSource) throws IOException;

    /**
     * Scans a document.
     *
     * @param complete True if the scanner should scan the document completely,
     *                 pushing all events to the registered document handler. A
     *                 value of false indicates that that the scanner should only
     *                 scan the next portion of the document and return. A scanner
     *                 instance is permitted to completely scan a document if it
     *                 does not support this "pull" scanning model.
     *
     * @return True if there is more to scan, false otherwise.
     * @throws IOException  Thrown on i/o error.
     * @throws XNIException on error.
     */
    boolean scanDocument(boolean complete) throws IOException, XNIException;
}