org.xs4j.xmlspitter.OutputSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlslurper Show documentation

An attempt to port parsing capabilities offered by Groovy XMLSlurper into the Java world. The following is not planned to be accurate projection, instead the most useful functions will be implemented.

The newest version!

package org.xs4j.xmlspitter;

import org.xs4j.util.NotNull;

/**
 * A data structure holding an output source for the {@link XMLSpitter}. The following is mutable to enable
 * setting/changing the output source during runtime.
 */
public interface OutputSupplier {
    /**
     * Used internally to supply {@link XMLSpitter} with output.
     *
     * @return an output to which the document will be written
     */
    @NotNull
    T supply();

    /**
     * Sets the output to be used for new XML document writing.
     *
     * @param output being the supply
     * @return this instance of OutputSupplier. Used for convenience for method chaining.
     */
    OutputSupplier set(@NotNull T output);
}