Package com.suncode.pwfl.component

Class ComponentDefinitionBuilder<T extends ComponentDefinitionBuilder<T>>

java.lang.Object

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

Direct Known Subclasses:

ActionDefinitionBuilder, ApplicationDefinitionBuilder, CommonDefinitionBuilder, DataChooserDefinitionBuilder, DataSourceDefinitionBuilder, EventActionDefinitionBuilder, ScheduledTaskDefinitionBuilder, ValidatorDefinitionBuilder, VariableSetterDefinitionBuilder

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

Builder to create component definition ComponentDefinition

Author:

Rafał Nowacki 13 kwi 2016

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Category>	categories
protected List<ContextVariable<?>>	contextVariables
protected LocalizedString	deprecationDescription
protected LocalizedString	description
protected String	documentationLink
protected Icon	icon
protected String	id
protected LocalizedString	name
protected List<ParameterDefinition<?>>	parameters
protected final Translator	translator

Constructor Summary

Constructors

Constructor	Description
ComponentDefinitionBuilder()
ComponentDefinitionBuilder(Translator translator)

Method Summary

Modifier and Type	Method	Description
T	category(Category... categories)	Sets component categories ComponentDefinition.getCategories()
ContextVariableBuilder<T>	contextVariable()	Starts building context variable with ContextVariableBuilder
protected T	contextVariable(ContextVariable<?> variable)
abstract ComponentDefinition	create()	Builds ComponentDefinition with given information.
T	deprecationDescription(String deprecationDescription)	Sets component deprecated description ComponentDefinition.getDeprecationDescription()
T	description(String description)	Sets component description ComponentDefinition.getDescription()
T	documentationLink(String documentationLink)	Sets link to component documentation prepend with server address taken from system parameters ComponentDefinition.getDocumentationLink()
protected abstract T	getThis()
T	icon(Icon icon)	Sets component icon ComponentDefinition.getIcon()
T	id(String id)	Sets component id ComponentDefinition.getId()
T	name(String name)	Sets component name ComponentDefinition.getName()
ParameterDefinitionBuilder<T>	parameter()	Starts building parameter definition of component with ParameterBuilder
protected T	parameter(ParameterDefinition<?> parameter)
LocalizedString	translated(String message)

Methods inherited from class java.lang.Object

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

Field Details

translator

protected final Translator translator

id

protected String id

documentationLink

protected String documentationLink

name

protected LocalizedString name

description

protected LocalizedString description

icon

protected Icon icon

categories

protected List<Category> categories

parameters

protected List<ParameterDefinition<?>> parameters

contextVariables

protected List<ContextVariable<?>> contextVariables

deprecationDescription

protected LocalizedString deprecationDescription

Constructor Details

ComponentDefinitionBuilder

public ComponentDefinitionBuilder()

ComponentDefinitionBuilder

public ComponentDefinitionBuilder(Translator translator)

Method Details

getThis

protected abstract T getThis()

create

public abstract ComponentDefinition create()

Builds ComponentDefinition with given information.

Returns:

Component definition

id

public T id(String id)

Sets component id ComponentDefinition.getId()

Parameters:

id - Component id.

Returns:

this

documentationLink

@Nullable
public T documentationLink(String documentationLink)

Sets link to component documentation prepend with server address taken from system parameters ComponentDefinition.getDocumentationLink()

Parameters:

documentationLink - path to component documentation.

Returns:

this

name

public T name(String name)

Sets component name ComponentDefinition.getName()

Parameters:

name - Component name or translation key.

Returns:

this

description

public T description(String description)

Sets component description ComponentDefinition.getDescription()

Parameters:

description - Component description or translation key.

Returns:

this

deprecationDescription

public T deprecationDescription(String deprecationDescription)

Sets component deprecated description ComponentDefinition.getDeprecationDescription()

Parameters:

deprecationDescription - Component deprecated description or translation key.

Returns:

this

icon

public T icon(Icon icon)

Sets component icon ComponentDefinition.getIcon()

Parameters:

icon - Component icon.

Returns:

this

category

public T category(Category... categories)

Sets component categories ComponentDefinition.getCategories()

Parameters:

categories - Component categories.

Returns:

this

parameter

public ParameterDefinitionBuilder<T> parameter()

Starts building parameter definition of component with ParameterBuilder

Returns:

Parameter builder

parameter

protected T parameter(ParameterDefinition<?> parameter)

contextVariable

public ContextVariableBuilder<T> contextVariable()

Starts building context variable with ContextVariableBuilder

Returns:

Context variable builder

contextVariable

protected T contextVariable(ContextVariable<?> variable)

translated

public LocalizedString translated(String message)