com.dtolabs.rundeck.core.plugins.configuration

Class PropertyUtil

java.lang.Object

com.dtolabs.rundeck.core.plugins.configuration.PropertyUtil

public class PropertyUtil
extends java.lang.Object

PropertyUtil factory for specific property types

Constructor Summary

Constructors

Constructor and Description
PropertyUtil()

Method Summary

Modifier and Type	Method and Description
static Property	bool(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue)
static com.dtolabs.rundeck.core.plugins.configuration.PropertyUtil.BooleanProperty	bool(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyScope scope)
static com.dtolabs.rundeck.core.plugins.configuration.PropertyUtil.BooleanProperty	bool(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values, java.util.Map<java.lang.String,java.lang.String> labels, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions, boolean dynamicValues)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values, java.util.Map<java.lang.String,java.lang.String> labels, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions, boolean dynamicValues, boolean blankIfUnexpandable)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values, PropertyValidator validator)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values, PropertyValidator validator, PropertyScope scope)
static Property	forType(Property.Type type, java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> values, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	freeSelect(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues)
static Property	freeSelect(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, java.util.Map<java.lang.String,java.lang.String> labels, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	freeSelect(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, PropertyValidator validator)
static Property	freeSelect(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, PropertyValidator validator, PropertyScope scope)
static Property	freeSelect(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	integer(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue)
static Property	integer(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator)
static Property	integer(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope)
static Property	integer(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	longProp(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue)
static Property	longProp(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator)
static Property	longProp(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope)
static Property	longProp(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	options(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, java.util.Map<java.lang.String,java.lang.String> labels, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.Collection<? extends java.lang.Enum<?>> selectValues, java.util.Map<java.lang.String,java.lang.String> selectLabels, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.Collection<? extends java.lang.Enum<?>> selectValues, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, java.util.Map<java.lang.String,java.lang.String> selectLabels, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions, boolean dynamicValues)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, PropertyScope scope)
static Property	select(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, java.util.List<java.lang.String> selectValues, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	string(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue)
static Property	string(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator)
static Property	string(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope)
static Property	string(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions)
static Property	string(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, java.lang.String defaultValue, PropertyValidator validator, PropertyScope scope, java.util.Map<java.lang.String,java.lang.Object> renderingOptions, boolean blankIfUnexpandable)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUtil

public PropertyUtil()

Method Detail

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

Returns:

a property instance for a particular simple type

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values,
                               PropertyValidator validator)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

validator - validator

Returns:

a property instance for a particular simple type

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values,
                               PropertyValidator validator,
                               PropertyScope scope)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

validator - validator

scope - resolution scope

Returns:

a property instance for a particular simple type

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values,
                               PropertyValidator validator,
                               PropertyScope scope,
                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a property instance for a particular simple type

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values,
                               java.util.Map<java.lang.String,java.lang.String> labels,
                               PropertyValidator validator,
                               PropertyScope scope,
                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions,
                               boolean dynamicValues)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a property instance for a particular simple type

forType

public static Property forType(Property.Type type,
                               java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> values,
                               java.util.Map<java.lang.String,java.lang.String> labels,
                               PropertyValidator validator,
                               PropertyScope scope,
                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions,
                               boolean dynamicValues,
                               boolean blankIfUnexpandable)

Parameters:

type - type

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

values - optional values list

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a property instance for a particular simple type

string

public static Property string(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

Returns:

a string property

string

public static Property string(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              PropertyValidator validator)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

Returns:

a string property

string

public static Property string(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              PropertyValidator validator,
                              PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

Returns:

Return a string property

string

public static Property string(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              PropertyValidator validator,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

Return a string property

string

public static Property string(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              PropertyValidator validator,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions,
                              boolean blankIfUnexpandable)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

Return a string property

bool

public static Property bool(java.lang.String name,
                            java.lang.String title,
                            java.lang.String description,
                            boolean required,
                            java.lang.String defaultValue)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

Returns:

Return a boolean property

bool

public static com.dtolabs.rundeck.core.plugins.configuration.PropertyUtil.BooleanProperty bool(java.lang.String name,
                                                                                               java.lang.String title,
                                                                                               java.lang.String description,
                                                                                               boolean required,
                                                                                               java.lang.String defaultValue,
                                                                                               PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

scope - resolution scope

Returns:

Return a boolean property

bool

public static com.dtolabs.rundeck.core.plugins.configuration.PropertyUtil.BooleanProperty bool(java.lang.String name,
                                                                                               java.lang.String title,
                                                                                               java.lang.String description,
                                                                                               boolean required,
                                                                                               java.lang.String defaultValue,
                                                                                               PropertyScope scope,
                                                                                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

scope - resolution scope

renderingOptions - options

Returns:

a boolean property

integer

public static Property integer(java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

Returns:

an integer property

integer

public static Property integer(java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               PropertyValidator validator)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

Returns:

an integer property with additional validator

integer

public static Property integer(java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               PropertyValidator validator,
                               PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

Returns:

an integer property with additional validator

integer

public static Property integer(java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               PropertyValidator validator,
                               PropertyScope scope,
                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

an integer property with additional validator

longProp

public static Property longProp(java.lang.String name,
                                java.lang.String title,
                                java.lang.String description,
                                boolean required,
                                java.lang.String defaultValue)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

Returns:

a long property

longProp

public static Property longProp(java.lang.String name,
                                java.lang.String title,
                                java.lang.String description,
                                boolean required,
                                java.lang.String defaultValue,
                                PropertyValidator validator)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

Returns:

a long property

longProp

public static Property longProp(java.lang.String name,
                                java.lang.String title,
                                java.lang.String description,
                                boolean required,
                                java.lang.String defaultValue,
                                PropertyValidator validator,
                                PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

Returns:

a long property

longProp

public static Property longProp(java.lang.String name,
                                java.lang.String title,
                                java.lang.String description,
                                boolean required,
                                java.lang.String defaultValue,
                                PropertyValidator validator,
                                PropertyScope scope,
                                java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a long property

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.List<java.lang.String> selectValues)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

Returns:

a Select property with a list of values

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.List<java.lang.String> selectValues,
                              PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

Returns:

a Select property with a list of values

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.List<java.lang.String> selectValues,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

renderingOptions - options

Returns:

a Select property with a list of values

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.List<java.lang.String> selectValues,
                              java.util.Map<java.lang.String,java.lang.String> selectLabels,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions,
                              boolean dynamicValues)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

renderingOptions - options

Returns:

a Select property with a list of values

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.Collection<? extends java.lang.Enum<?>> selectValues,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

renderingOptions - options

Returns:

a Select property with a list of values

select

public static Property select(java.lang.String name,
                              java.lang.String title,
                              java.lang.String description,
                              boolean required,
                              java.lang.String defaultValue,
                              java.util.Collection<? extends java.lang.Enum<?>> selectValues,
                              java.util.Map<java.lang.String,java.lang.String> selectLabels,
                              PropertyScope scope,
                              java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

renderingOptions - options

Returns:

a Select property with a list of values

freeSelect

public static Property freeSelect(java.lang.String name,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean required,
                                  java.lang.String defaultValue,
                                  java.util.List<java.lang.String> selectValues)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

Returns:

a Free Select property with a list of values

freeSelect

public static Property freeSelect(java.lang.String name,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean required,
                                  java.lang.String defaultValue,
                                  java.util.List<java.lang.String> selectValues,
                                  PropertyValidator validator)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

validator - validator

Returns:

a Free Select property with a list of values

freeSelect

public static Property freeSelect(java.lang.String name,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean required,
                                  java.lang.String defaultValue,
                                  java.util.List<java.lang.String> selectValues,
                                  PropertyValidator validator,
                                  PropertyScope scope)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

validator - validator

scope - resolution scope

Returns:

a Free Select property with a list of values

freeSelect

public static Property freeSelect(java.lang.String name,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean required,
                                  java.lang.String defaultValue,
                                  java.util.List<java.lang.String> selectValues,
                                  PropertyValidator validator,
                                  PropertyScope scope,
                                  java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a Free Select property with a list of values

freeSelect

public static Property freeSelect(java.lang.String name,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean required,
                                  java.lang.String defaultValue,
                                  java.util.List<java.lang.String> selectValues,
                                  java.util.Map<java.lang.String,java.lang.String> labels,
                                  PropertyValidator validator,
                                  PropertyScope scope,
                                  java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

validator - validator

scope - resolution scope

renderingOptions - options

Returns:

a Free Select property with a list of values

options

public static Property options(java.lang.String name,
                               java.lang.String title,
                               java.lang.String description,
                               boolean required,
                               java.lang.String defaultValue,
                               java.util.List<java.lang.String> selectValues,
                               java.util.Map<java.lang.String,java.lang.String> labels,
                               PropertyScope scope,
                               java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Parameters:

name - name

title - optional title

description - optional description

required - true if required

defaultValue - optional default value

selectValues - optional values list

scope - resolution scope

renderingOptions - options

Returns:

a Free Select property with a list of values