com.dtolabs.rundeck.plugins.descriptions

Annotation Type PluginProperty

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface PluginProperty

Declares a Plugin class' field as a configurable property

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	defaultValue
java.lang.String	description
java.lang.String	name
boolean	required
PropertyScope	scope
java.lang.String	title
java.lang.Class<?>	validatorClass
java.lang.String	validatorClassName

Element Detail

name

public abstract java.lang.String name

Returns:

The property identifier name

Default:

""

title

public abstract java.lang.String title

Returns:

The property display name

Default:

""

description

public abstract java.lang.String description

Returns:

The property description

Default:

""

defaultValue

public abstract java.lang.String defaultValue

Returns:

The default value as a string

Default:

""

required

public abstract boolean required

Returns:

True if the property value is required

Default:

false

scope

public abstract PropertyScope scope

Returns:

The scope for resolving the property value at runtime

Default:

com.dtolabs.rundeck.core.plugins.configuration.PropertyScope.Unspecified

validatorClassName

public abstract java.lang.String validatorClassName

Returns:

class name of a validator to use

Default:

""

validatorClass

public abstract java.lang.Class<?> validatorClass

Returns:

class of a validator to use

Default:

java.lang.Object.class