net.sf.saxon.om.AtomizedValueIterator 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-2022 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.om;

import net.sf.saxon.trans.XPathException;

/**
 * Interface implemented by an iterator that can deliver atomized results.
 *
 * This exists to make it possible to iterate over the atomized nodes
 * in a sequence, especially a sequence obtained from the TinyTree,
 * without actually instantiating the nodes themselves.
 */

public interface AtomizedValueIterator extends SequenceIterator {

    /**
     * Deliver the atomic value that is next in the atomized result
     * @return the next atomic value
     * @throws XPathException if a failure occurs reading or atomizing the next value
     */

    AtomicSequence nextAtomizedValue() throws XPathException;

}