net.sf.saxon.pull.UnfailingPullProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation

The XSLT and XQuery Processor

There is a newer version: 12.5

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.pull;

import net.sf.saxon.om.AttributeMap;
import net.sf.saxon.om.NamespaceBinding;
import net.sf.saxon.om.NodeName;
import net.sf.saxon.s9api.Location;
import net.sf.saxon.str.UnicodeString;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.value.AtomicValue;

import java.util.List;

/**
 * PullProvider is Saxon's pull-based interface for reading XML documents and XDM sequences.
 * A PullProvider can deliver any sequence of nodes or atomic values.
 *
 * An {@code UnfailingPullProvider} is a subtype where the methods throw no checked Exceptions.
 */

public interface UnfailingPullProvider extends PullProvider {

    @Override
    PullEvent next() throws XPathException;

    @Override
    PullEvent current();

    @Override
    AttributeMap getAttributes();

    @Override
    NamespaceBinding[] getNamespaceDeclarations();

    @Override
    PullEvent skipToMatchingEnd();

    @Override
    void close();

    @Override
    NodeName getNodeName();

    @Override
    UnicodeString getStringValue() throws XPathException;

    @Override
    SchemaType getSchemaType();

    @Override
    AtomicValue getAtomicValue();

    @Override
    Location getSourceLocator();

    @Override
    List getUnparsedEntities();
}