com.thoughtworks.go.plugin.api.task

Class TaskConfig

java.lang.Object

com.thoughtworks.go.plugin.api.config.Configuration

com.thoughtworks.go.plugin.api.task.TaskConfig

All Implemented Interfaces:

PluginPreference

public class TaskConfig
extends Configuration

Allows the plugin to specify information about the configuration it accepts and expects. This class, at other times, is used to hold information about the value provided by the user, for the configuration.

Constructor Summary

Constructors

Constructor and Description
TaskConfig()

Method Summary

Modifier and Type	Method and Description
TaskConfigProperty	addProperty(String propertyName) Adds a property to the configuration of this task.
String	getValue(String propertyName) Retrieves the value of a property.
List<? extends Property>	list() Returns copy of properties list

Methods inherited from class com.thoughtworks.go.plugin.api.config.Configuration

add, get, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskConfig

public TaskConfig()

Method Detail

addProperty

public TaskConfigProperty addProperty(String propertyName)

Adds a property to the configuration of this task.

Parameters:

propertyName - Name of the property (or key) in the configuration.

Returns:

an instance of TaskConfigProperty

getValue

public String getValue(String propertyName)

Retrieves the value of a property.

Parameters:

propertyName - Name of the property (or key) in the configuration.

Returns:

the value of the specified property, or null if not found.

list

public List<? extends Property> list()

Description copied from class: Configuration

Returns copy of properties list

Overrides:

list in class Configuration

Returns:

copy of properties list