com.xebialabs.deployit.plugin.api.rules

Annotation Type StepParameter

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface StepParameter

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	description

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	calculated
java.lang.String	name
boolean	required

Element Detail

description

public abstract java.lang.String description

Returns:

Description of the parameter.

name

public abstract java.lang.String name

Returns:

Name of the step parameter as used in xml.

Default:

""

required

public abstract boolean required

Returns:

whether or not this parameter is required. Defaults to true.

Default:

true

calculated

public abstract boolean calculated

Returns:

whether or not value for this parameter is calculated by rule engine. Defaults to false.

Default:

false