net.sf.saxon.sapling.Saplings 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.sapling;

import net.sf.saxon.s9api.QName;

/**
 * This is a non-instantiable class holding a number of convenience methods for creating
 * sapling nodes of different kinds.
 *
 * @see SaplingNode
 */

public class Saplings {

    private Saplings(){}

    /**
     * Create a sapling document node, with no children
     * @return the new node
     */

    public static SaplingDocument doc() {
        return new SaplingDocument();
    }

    /**
     * Create a sapling document node with a specified base URI, with no children
     * @param baseUri the base URI of the document
     * @return the new node
     */

    public static SaplingDocument doc(String baseUri) {
        return new SaplingDocument(baseUri);
    }

    /**
     * Create a sapling element node, in no namespace, with no attributes and no children
     * @param name the local name of the element node. This must be a valid NCName, but the
     *             current implementation does not check this.
     * @return the new node
     */

    public static SaplingElement elem(String name) {
        return new SaplingElement(name);
    }

    /**
     * Create a sapling element node, which may or may not be in a namespace, with no attributes and no children
     *
     * @param qName the qualified name of the element. The current implementation does not check that the
     *              parts of the qualified name are syntactically valid.
     * @return the new node
     */

    public static SaplingElement elem(QName qName) {
        return new SaplingElement(qName);
    }

    /**
     * Create a sapling text node, with a given string value
     * @param value the string value of the text node
     * @return the new node
     */

    public static SaplingText text(String value) {
        return new SaplingText(value);
    }

    /**
     * Create a sapling comment node, with a given string value
     *
     * @param value the string value of the comment node. This must not contain "--" as a substring,
     *              but the current implementation does not check this.
     * @return the new node
     */

    public static SaplingComment comment(String value) {
        return new SaplingComment(value);
    }

    /**
     * Create a sapling processing instruction node, with a given name and string value
     * @param target the target (name) of the processing instruction. This must be a valid NCName,
     *               but the current implementation does not check this.
     * @param data the string value of the processing instruction node. This must not contain {@code "?>"} as a substring,
     *               but the current implementation does not check this.
     * @return the new node
     */

    public static SaplingProcessingInstruction pi(String target, String data) {
        return new SaplingProcessingInstruction(target, data);
    }
}