com.greenpepper.document.AbstractSpecification Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of greenpepper-core Show documentation
The newest version!
package com.greenpepper.document;

import java.util.Map;

import com.greenpepper.Example;
import com.greenpepper.Specification;
import com.greenpepper.Statistics;
import com.greenpepper.Variables;
import com.greenpepper.util.ExampleWrapper;

/**
 * Abstract AbstractSpecification class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public abstract class AbstractSpecification implements Specification
{
    protected final Variables variables = new Variables();
    protected Example cursor;

    /**
     * setStart.
     *
     * @param example a {@link com.greenpepper.Example} object.
     */
    protected void setStart( Example example )
    {
        this.cursor = before( example );
    }

    private Example before( Example example )
    {
        return ExampleWrapper.empty( example );
    }

    /**
     * nextExample.
     *
     * @return a {@link com.greenpepper.Example} object.
     */
    public Example nextExample()
    {
        cursor = peek();
        return cursor;
    }
    
    /**
     * getAllVariables.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getAllVariables()
    {
    	return variables.getAllVariables();
    }
    
    /**
     * peek.
     *
     * @return a {@link com.greenpepper.Example} object.
     */
    protected abstract Example peek();

    /**
     * hasMoreExamples.
     *
     * @return a boolean.
     */
    public boolean hasMoreExamples()
    {
        return peek() != null;
    }

    /** {@inheritDoc} */
    public abstract void exampleDone( Statistics statistics );

    /** {@inheritDoc} */
    public Object getVariable(String symbol)
    {
        return variables.getVariable( symbol );
    }

    /** {@inheritDoc} */
    public void setVariable(String symbol, Object value)
    {
        variables.setVariable( symbol, value );
    }
}