org.specrunner.expressions.IExpression Maven / Gradle / Ivy

Go to download
/*
    SpecRunner - Acceptance Test Driven Development Tool
    Copyright (C) 2011-2013  Thiago Santos

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see 
 */
package org.specrunner.expressions;

import org.specrunner.context.IContext;

/**
 * An expression.
 * 
 * @author Thiago Santos
 * 
 */
public interface IExpression {

    /**
     * The mother factory.
     * 
     * @return The factory where the expression came from.
     */
    IExpressionFactory getParent();

    /**
     * Given a context, evaluates an expression silently.
     * 
     * @param context
     *            A contextual information.
     * @return The result of expression evaluation.
     * @throws ExpressionException
     *             On evaluation errors.
     */
    Object evaluate(IContext context) throws ExpressionException;

    /**
     * Given a context, evaluates the expression.
     * 
     * @param context
     *            A contextual information.
     * @param silent
     *            true, for evaluation without exceptions,
     *            false, otherwise.
     * @return The result of expression evaluation.
     * @throws ExpressionException
     *             On evaluation errors.
     */
    Object evaluate(IContext context, boolean silent) throws ExpressionException;
}