StreamStatus.java

/*
 * The MIT License
 *
 * Copyright (c) 2010 tap4j team (see AUTHORS)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.tap4j.parser;

import org.tap4j.model.TapElement;
import org.tap4j.model.TestSet;

/**
 * StreamStatus for parsers. Stores information about a parser in certain moment
 * of the parsing method.
 *
 * @since 3.0
 */
public class StreamStatus {

    /**
     * If it processed only the first line.
     */
    private boolean firstLine = true;

    /**
     * If the plan must come before the test result.
     */
    private boolean planBeforeTestResult = false;

    /**
     * The last line processed.
     */
    private String lastLine = null;

    /**
     * The last element parsed.
     */
    private TapElement lastParsedElement = null;

    /**
     * Indicator of the base indentation level. Usually defined by the TAP
     * Header.
     */
    private int indentationLevel = 0;

    /**
     * If we are processing a YAMLish block.
     */
    private boolean currentlyInYaml = false;

    /**
     * The indentation of the Yaml block.
     */
    private String yamlIndentation = "";


    /**
     * Diagnostics buffer.
     */
    private final StringBuilder diagnosticBuffer = new StringBuilder();

    /**
     * The immutable test set.
     */
    private final TestSet testSet = new TestSet();

    /**
     * In case sub-tests could not have been attached to parent (as the sub-tests came first)
     * we need to make sure we make the link as the parent test comes.
     */
    protected boolean attachedToParent;

    /**
     * Stream status test set.
     */
    protected TestSet looseSubtests; 

    /**
     * Default constructor.
     */
    public StreamStatus() {
        super();
    }

    /**
     * @return if is first line
     */
    public boolean isFirstLine() {
        return firstLine;
    }

    /**
     * @param firstLine is first line value
     */
    public void setFirstLine(boolean firstLine) {
        this.firstLine = firstLine;
    }

    /**
     * @return the planBeforeTestResult
     */
    public boolean isPlanBeforeTestResult() {
        return planBeforeTestResult;
    }

    /**
     * @param planBeforeTestResult the planBeforeTestResult to set
     */
    public void setPlanBeforeTestResult(boolean planBeforeTestResult) {
        this.planBeforeTestResult = planBeforeTestResult;
    }

    /**
     * @return the lastLine
     */
    public String getLastLine() {
        return lastLine;
    }

    /**
     * @param lastLine the lastLine to set
     */
    public void setLastLine(String lastLine) {
        this.lastLine = lastLine;
    }

    /**
     * @return the lastParsedElement
     */
    public TapElement getLastParsedElement() {
        return lastParsedElement;
    }

    /**
     * @param lastParsedElement the lastParsedElement to set
     */
    public void setLastParsedElement(TapElement lastParsedElement) {
        this.lastParsedElement = lastParsedElement;
    }

    /**
     * @return the baseIndentationLevel
     */
    public int getIndentationLevel() {
        return indentationLevel;
    }

    /**
     * @param indentationLevel the baseIndentationLevel to set
     */
    public void setIndentationLevel(int indentationLevel) {
        this.indentationLevel = indentationLevel;
    }

    /**
     * @return the currentlyInYaml
     */
    public boolean isInYaml() {
        return currentlyInYaml;
    }

    /**
     * @param currentlyInYaml the currentlyInYaml to set
     */
    public void setInYaml(boolean currentlyInYaml) {
        this.currentlyInYaml = currentlyInYaml;
    }

    /**
     * @return the diagnosticBuffer
     */
    public StringBuilder getDiagnosticBuffer() {
        return diagnosticBuffer;
    }

    /**
     * @return the testSet
     */
    public TestSet getTestSet() {
        return testSet;
    }

    /**
     * @return the yamlIndentation
     */
    public String getYamlIndentation() {
        return yamlIndentation;
    }

    /**
     * @param yamlIndentation the yamlIndentation to set
     */
    public void setYamlIndentation(String yamlIndentation) {
        this.yamlIndentation = yamlIndentation;
    }
}