com.xebialabs.deployit
Annotation Type ConfigurationItemProperty

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

Specifies that this field is part of the configuration item. It will be injected with the correct value to be read from runbooks.

Optional Element Summary

java.lang.String	category The category of this property.
java.lang.String	description The description of this property as it should be shown in the user interface.
boolean	editable Whether this property is editable by the user.
boolean	identifying Whether this property should be considered when comparing this CI to another CI to check if they are similar.
java.lang.String	label The descriptive label of this property as it should be shown in the user interface.
boolean	password Whether this property is a password property.
boolean	required Whether this property is required.
ConfigurationItemProperty.Size	size The size of this property as it should be shown in the user interface.

category

public abstract java.lang.String category

The category of this property. In the user interface all the properties belonging to the same category will be grouped together.

Default:

"Common"

label

public abstract java.lang.String label

The descriptive label of this property as it should be shown in the user interface. If no label is not specified, the name of the field is used. Camel case in the field name is replaced by spaces and the first character is capitalized, e.g. "classLoaderPolicy" is transformed into "Class loader policy".

Default:

""

description

public abstract java.lang.String description

The description of this property as it should be shown in the user interface. If no description is specified, the label is used.

Default:

""

required

public abstract boolean required

Whether this property is required.

Default:

false

editable

public abstract boolean editable

Whether this property is editable by the user.

Default:

true

password

public abstract boolean password

Whether this property is a password property. If true this field will be masked in the user interface.

Default:

false

identifying

public abstract boolean identifying

Whether this property should be considered when comparing this CI to another CI to check if they are similar.

Default:

false

size

public abstract ConfigurationItemProperty.Size size

The size of this property as it should be shown in the user interface.

Default:

com.xebialabs.deployit.ConfigurationItemProperty.Size.DEFAULT