com.thoughtworks.go.plugin.api.config

Class Property

java.lang.Object

com.thoughtworks.go.plugin.api.config.Property

Direct Known Subclasses:

PackageMaterialProperty, TaskConfigProperty

public class Property
extends Object

Represents single configuration property. A given property can have set of metadata which can be represented by options. The valid options are Property.REQUIRED, Property.PART_OF_IDENTITY, Property.SECURE, Property.DISPLAY_NAME and Property.DISPLAY_ORDER

Field Summary

Fields

Modifier and Type	Field and Description
static Option<String>	DISPLAY_NAME Option to specify the display name for the property
static Option<Integer>	DISPLAY_ORDER Option to specify order of display of property on screen
static Option<Boolean>	PART_OF_IDENTITY Option to specify if a property is part of group of properties used to uniquely identify material
static Option<Boolean>	REQUIRED Option to specify if a property is a mandatory when configuration is captured
static Option<Boolean>	SECURE Option to specify if a property is a secure property.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Property(String key)
protected	Property(String key, String value)
	Property(String key, String value, String defaultValue)

Method Summary

Modifier and Type	Method and Description
String	getKey() Gets property key
<T> T	getOption(Option<T> option) Gets value for given option
Options	getOptions() Gets all options of property
String	getValue() Gets property value.
<T> Property	with(Option<T> option, T value) Adds an option
Property	withDefault(String defaultValue)

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED

public static final Option<Boolean> REQUIRED

Option to specify if a property is a mandatory when configuration is captured

PART_OF_IDENTITY

public static final Option<Boolean> PART_OF_IDENTITY

Option to specify if a property is part of group of properties used to uniquely identify material

SECURE

public static final Option<Boolean> SECURE

Option to specify if a property is a secure property. If the property is secure, property value will be always stored (in configuration) and displayed in encrypted text

DISPLAY_NAME

public static final Option<String> DISPLAY_NAME

Option to specify the display name for the property

DISPLAY_ORDER

public static final Option<Integer> DISPLAY_ORDER

Option to specify order of display of property on screen

Constructor Detail

Property

public Property(String key)

Property

protected Property(String key,
                   String value)

Property

public Property(String key,
                String value,
                String defaultValue)

Method Detail

getKey

public String getKey()

Gets property key

Returns:

property key

with

public final <T> Property with(Option<T> option,
                               T value)

Adds an option

Type Parameters:

T - Type of option value

Parameters:

option - Option type to be added

value - Option value

Returns:

current property instance (this)

getValue

public String getValue()

Gets property value.

Returns:

property value

getOption

public <T> T getOption(Option<T> option)

Gets value for given option

Type Parameters:

T - type of option

Parameters:

option - for which value needs to fetched

Returns:

option value

getOptions

public Options getOptions()

Gets all options of property

Returns:

all options of property

withDefault

public Property withDefault(String defaultValue)