hu.ibello.steps.StepLibraryTool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ibello-api Show documentation

Ibello is an easy-to-use automated test framework for web applications. It's public API is ibello-api.

There is a newer version: 1.22.0

/*
 * Ark-Sys Kft. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package hu.ibello.steps;

import hu.ibello.core.Value;

/**
 * Helper interface for step libraries.
 * 
 * There is no need to use this interface directly.
 * The ibello dependency injection system automatically instantiates and injects
 * an instance into step libraries.
 * 
 * @see StepLibrary
 * @author Kornél Simon
 */
public interface StepLibraryTool {

	/**
	 * Returns a configuration property as a {@link Value}. The returned value offers some public methods to
	 * transform the configuration property into different java types.
	 * This method always has a non-null result, even if the configuration value does not exist - in this case,
	 * the wrapped value will be null.
	 * @param name name of the configuration parameter
	 * @return value of the configuration parameter wrapped into a {@link Value} instance
	 */
	Value getConfigurationValue(String name);
}