com.dtolabs.rundeck.plugins.util

Class PropertyBuilder

java.lang.Object

com.dtolabs.rundeck.plugins.util.PropertyBuilder

public class PropertyBuilder
extends java.lang.Object

A builder for Property objects

Method Summary

Methods

Modifier and Type	Method and Description
PropertyBuilder	booleanType(java.lang.String name) Return a new PropertyBuilder of type Property.Type#Boolean
Property	build() Build the Property object
static PropertyBuilder	builder()
static PropertyBuilder	builder(Property orig) Return a new instance preconfigured with a previously defined Property
PropertyBuilder	defaultValue(java.lang.String value) Set the default value
PropertyBuilder	description(java.lang.String description) Set the description
PropertyBuilder	freeSelect(java.lang.String name) Return a new PropertyBuilder of type Property.Type#FreeSelect
Property.Type	getType()
PropertyBuilder	integer(java.lang.String name) Return a new PropertyBuilder of type Property.Type#Integer
PropertyBuilder	longType(java.lang.String name) Return a new PropertyBuilder of type Property.Type#Long
PropertyBuilder	name(java.lang.String name) Set the name (identifier)
PropertyBuilder	renderingAsPassword() Set the string property to display as a Password.
PropertyBuilder	renderingAsTextarea() Set the string property to display as a Multi-line Text area.
PropertyBuilder	renderingOption(java.lang.String optionKey, java.lang.Object optionValue) Adds the given renderingOption
PropertyBuilder	renderingOptions(java.util.Map<java.lang.String,java.lang.Object> renderingOptions) Adds all rendering options from the given renderingOptions
PropertyBuilder	required(boolean required) Set required
PropertyBuilder	scope(PropertyScope scope) Set the property scope
PropertyBuilder	select(java.lang.String name) Return a new PropertyBuilder of type Property.Type#Select
PropertyBuilder	string(java.lang.String name) Return a new PropertyBuilder of type Property.Type#String
PropertyBuilder	title(java.lang.String title) Set the title (display name)
PropertyBuilder	type(Property.Type type) Set the type
PropertyBuilder	validator(PropertyValidator validator) Set the property validator, only applies to String, Integer, Long, and FreeSelect types
PropertyBuilder	values(java.util.List<java.lang.String> values) Set the select values
PropertyBuilder	values(java.lang.String... values) Set the select values

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PropertyBuilder builder()

builder

public static PropertyBuilder builder(Property orig)

Return a new instance preconfigured with a previously defined Property

Parameters:

orig - original property

Returns:

this builder

string

public PropertyBuilder string(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#String

Parameters:

name - name

Returns:

this builder

booleanType

public PropertyBuilder booleanType(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#Boolean

Parameters:

name - name

Returns:

this builder

integer

public PropertyBuilder integer(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#Integer

Parameters:

name - name

Returns:

this builder

longType

public PropertyBuilder longType(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#Long

Parameters:

name - name

Returns:

this builder

select

public PropertyBuilder select(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#Select

Parameters:

name - name

Returns:

this builder

freeSelect

public PropertyBuilder freeSelect(java.lang.String name)

Return a new PropertyBuilder of type Property.Type#FreeSelect

Parameters:

name - name

Returns:

this builder

type

public PropertyBuilder type(Property.Type type)

Set the type

Parameters:

type - type

Returns:

this builder

name

public PropertyBuilder name(java.lang.String name)

Set the name (identifier)

Parameters:

name - name

Returns:

this builder

title

public PropertyBuilder title(java.lang.String title)

Set the title (display name)

Parameters:

title - title

Returns:

this builder

description

public PropertyBuilder description(java.lang.String description)

Set the description

Parameters:

description - description

Returns:

this builder

required

public PropertyBuilder required(boolean required)

Set required

Parameters:

required - true if required

Returns:

this builder

defaultValue

public PropertyBuilder defaultValue(java.lang.String value)

Set the default value

Parameters:

value - value

Returns:

this builder

values

public PropertyBuilder values(java.util.List<java.lang.String> values)

Set the select values

Parameters:

values - values

Returns:

this builder

values

public PropertyBuilder values(java.lang.String... values)

Set the select values

Parameters:

values - values

Returns:

this builder

validator

public PropertyBuilder validator(PropertyValidator validator)

Set the property validator, only applies to String, Integer, Long, and FreeSelect types

Parameters:

validator - validator

Returns:

this builder

scope

public PropertyBuilder scope(PropertyScope scope)

Set the property scope

Parameters:

scope - scope

Returns:

this builder

renderingOptions

public PropertyBuilder renderingOptions(java.util.Map<java.lang.String,java.lang.Object> renderingOptions)

Adds all rendering options from the given renderingOptions

Parameters:

renderingOptions - options

Returns:

this builder

See Also:

StringRenderingConstants

renderingOption

public PropertyBuilder renderingOption(java.lang.String optionKey,
                              java.lang.Object optionValue)

Adds the given renderingOption

Parameters:

optionKey - key

optionValue - value

Returns:

this builder

See Also:

StringRenderingConstants

renderingAsTextarea

public PropertyBuilder renderingAsTextarea()

Set the string property to display as a Multi-line Text area.

Returns:

this builder

Throws:

java.lang.IllegalStateException - if the property type is not Property.Type#String

renderingAsPassword

public PropertyBuilder renderingAsPassword()

Set the string property to display as a Password.

Returns:

this builder

Throws:

java.lang.IllegalStateException - if the property type is not Property.Type#String

build

public Property build()

Build the Property object

Returns:

built property

Throws:

java.lang.IllegalStateException - if type or name is not set

getType

public Property.Type getType()

Returns:

the type already defined for the builder