hu.ibello.core.Name 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.core;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * 
 * With this annotation we can assign visible name to a class (step library) or a method
 * (test step). If the annotation presents on a class or method, then ibello
 * will log the name specified by the annotation when the class/method name is going to be
 * logged.
 * 
 * 
 * The value may contain parameter substitution markers. A parameter substitution marker
 * is a 0-based index surrounded by ${ and }. These markers will
 * be replaced by string version of method parameters. For example, if the annotation's value
 * is "${0}-${1}", then the method will replace ${0} with the first
 * method parameter, and ${1} with the second parameter. If method parameters are
 * "a" and 1, then the result will be "a-1".
 * 
 * @author Kornél Simon
 */
@Retention(RUNTIME)
@Target({METHOD, TYPE})
public @interface Name {

	/**
	 * Visible name of a class (representing a step library) or a method (representing a test step).
	 * @return visible name of class or method
	 */
	String value();
}