net.sf.saxon.s9api.push.Document 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.s9api.push;

import net.sf.saxon.s9api.SaxonApiException;

/**
 * A {@link Container} representing a document node.
 *
 * If the document is constrained to be well-formed then the permitted sequence of events is
 * {@code (COMMENT | PI)* ELEMENT (COMMENT | PI)* CLOSE}.
 *
 * If the document is NOT constrained to be well-formed then the permitted sequence of events is
 * {@code (COMMENT | PI | TEXT | ELEMENT)* CLOSE}.
 */

public interface Document extends Container {

    @Override
    Document text(CharSequence value) throws SaxonApiException;

    @Override
    Document comment(CharSequence value) throws SaxonApiException;

    @Override
    Document processingInstruction(String name, CharSequence value) throws SaxonApiException;
}