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

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() Return the type already defined for the builder
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	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

string

public PropertyBuilder string(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.String

booleanType

public PropertyBuilder booleanType(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.Boolean

integer

public PropertyBuilder integer(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.Integer

longType

public PropertyBuilder longType(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.Long

select

public PropertyBuilder select(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.Select

freeSelect

public PropertyBuilder freeSelect(java.lang.String name)

Return a new PropertyBuilder of type Property.Type.FreeSelect

type

public PropertyBuilder type(Property.Type type)

Set the type

name

public PropertyBuilder name(java.lang.String name)

Set the name (identifier)

title

public PropertyBuilder title(java.lang.String title)

Set the title (display name)

description

public PropertyBuilder description(java.lang.String description)

Set the description

required

public PropertyBuilder required(boolean required)

Set required

defaultValue

public PropertyBuilder defaultValue(java.lang.String value)

Set the default value

values

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

Set the select values

values

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

Set the select values

validator

public PropertyBuilder validator(PropertyValidator validator)

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

scope

public PropertyBuilder scope(PropertyScope scope)

Set the property scope

renderingOptions

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

Adds all rendering options from the given renderingOptions

renderingOption

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

Adds the given renderingOption

build

public Property build()

Build the Property object

Throws:

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

getType

public Property.Type getType()

Return the type already defined for the builder

Returns: