org.specrunner.features.IFeatureManager Maven / Gradle / Ivy

Go to download
/*
    SpecRunner - Acceptance Test Driven Development Tool
    Copyright (C) 2011-2014  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.features;

import java.util.Map;

import org.specrunner.configuration.IConfiguration;

/**
 * This is the standard way of parameterizing the framework objects. This is the
 * standard way of parameterizing all tests in the same execution, to set
 * specific features for each test separately use IConfiguration object.
 * 
 * 
 * Every class can read a feature by
 * SpecRunnerService.get(IFeatureManager.class).getFeature("name").
 * See all IPlugin implementations to check all available features
 * and how to use them.
 * 
 * @author Thiago Santos
 * 
 */
public interface IFeatureManager extends Map {

    /**
     * Set a feature to a value.
     * 
     * @param feature
     *            The feature name.
     * @param value
     *            The value.
     * @return The manager itself.
     */
    IFeatureManager add(String feature, Object value);

    /**
     * Set a feature to a value.
     * 
     * @param feature
     *            The feature name.
     * @param value
     *            The value.
     * @param override
     *            true, if the value should overwrite previous values, false,
     *            otherwise.
     * @return The manager itself.
     */
    IFeatureManager add(String feature, Object value, boolean override);

    /**
     * Sets a feature to an object if the feature exists and the type is
     * compatible.
     * 
     * @param feature
     *            The feature name.
     * @param target
     *            The object where the feature must be set.
     */
    void set(String feature, Object target);

    /**
     * Sets a feature to an object if the feature exists and the type is
     * compatible. Throws error if set is not possible.
     * 
     * @param feature
     *            The feature name.
     * @param target
     *            The object where the feature must be set.
     * @throws FeatureManagerException
     *             On object setup.
     */
    void setStrict(String feature, Object target) throws FeatureManagerException;

    /**
     * Set a set of local configuration as complementary information to feature
     * settings. When a instance of a ISpecRunner received a
     * IConfiguration, this is set here as local and at the
     * beginning of a new test execution it can be just replaced.
     * 
     * @param cfg
     *            Set configuration features.
     */
    void setConfiguration(IConfiguration cfg);

    /**
     * Get a value from map, if not found, result is 'defaultValue'.
     * 
     * @param key
     *            A name.
     * @param defaultValue
     *            The default value.
     * @return The key value, or defaultValue, if not found.
     */
    Object get(String key, Object defaultValue);
}