com.suncode.pwfl.component

Class ParameterDefinitionBuilder<T extends ComponentDefinitionBuilder<T>>

java.lang.Object

com.suncode.pwfl.component.ParameterDefinitionBuilder<T>

@Api
public class ParameterDefinitionBuilder<T extends ComponentDefinitionBuilder<T>>
extends Object

Builder to create component parameter definition ParameterDefinition

Author:

Rafał Nowacki 13 kwi 2016

Constructor Summary

Constructors

Constructor and Description
ParameterDefinitionBuilder(ComponentDefinitionBuilder<T> componentBuilder)

Method Summary

Modifier and Type	Method and Description
ParameterDefinitionBuilder<T>	arrayMinLength(int length) Sets minimum required number of items for this array parameter.
T	create() Builds ParameterDefinition with given information.
ParameterDefinitionBuilder<T>	defaultValue(Object defaultValue) Sets parameter default value ParameterDefinition.getDefaultValue()
ParameterDefinitionBuilder<T>	description(String description) Sets parameter description ParameterDefinition.getDescription()
ParameterDefinitionBuilder<T>	id(String id) Sets parameter id ParameterDefinition.getId()
ParameterDefinitionBuilder<T>	name(String name) Sets parameter name ParameterDefinition.getName()
ParameterDefinitionBuilder<T>	optional() Sets parameter to optional
ParameterDefinitionBuilder<T>	recommendedFunctions(String... recommendedFunctions) Sets parameter recommended functions ParameterDefinition.getRecommendedFunctions()
ParameterDefinitionBuilder<T>	type(Type<?> type) Sets parameter type ParameterDefinition.getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDefinitionBuilder

public ParameterDefinitionBuilder(ComponentDefinitionBuilder<T> componentBuilder)

Method Detail

id

public ParameterDefinitionBuilder<T> id(String id)

Sets parameter id ParameterDefinition.getId()

Parameters:

id - Parameter id.

Returns:

this

name

public ParameterDefinitionBuilder<T> name(String name)

Sets parameter name ParameterDefinition.getName()

Parameters:

name - Parameter name or translation key.

Returns:

this

description

public ParameterDefinitionBuilder<T> description(String description)

Sets parameter description ParameterDefinition.getDescription()

Parameters:

description - Parameter description or translation key.

Returns:

this

type

public ParameterDefinitionBuilder<T> type(Type<?> type)

Sets parameter type ParameterDefinition.getType()

Parameters:

type - Type of parameter

Returns:

this

optional

public ParameterDefinitionBuilder<T> optional()

Sets parameter to optional

Returns:

this

defaultValue

public ParameterDefinitionBuilder<T> defaultValue(Object defaultValue)

Sets parameter default value ParameterDefinition.getDefaultValue()

Parameters:

defaultValue - default parameter value

Returns:

this

arrayMinLength

public ParameterDefinitionBuilder<T> arrayMinLength(int length)

Sets minimum required number of items for this array parameter.

Parameters:

length - required minimum number of items

Returns:

this

recommendedFunctions

public ParameterDefinitionBuilder<T> recommendedFunctions(String... recommendedFunctions)

Sets parameter recommended functions ParameterDefinition.getRecommendedFunctions()

Parameters:

defaultValue - default parameter value

Returns:

this

create

public T create()

Builds ParameterDefinition with given information.

Returns:

Component definition