org.togglz.core.activation

Class ParameterBuilder

java.lang.Object

org.togglz.core.activation.ParameterBuilder

All Implemented Interfaces:

Parameter

public class ParameterBuilder
extends Object
implements Parameter

Fluent API for creating Parameter instances.

Author:

Christian Kaltepoth

Method Summary

Modifier and Type	Method and Description
static ParameterBuilder	create(String name) Creates a new builder for a parameter with the given name.
ParameterBuilder	description(String description) Sets an optional description for the parameter displayed in the admin console.
String	getDescription() An optional description of the parameter.
String	getLabel() A human readable label that describes the parameter.
String	getName() The name of the parameter.
boolean	isLargeText() Returns true if the parameter value is typically large so that it should be displayed with an textarea instead of a simple text input field.
boolean	isOptional() Returns true if the parameter is optional.
boolean	isValid(String value) This method allows to implement custom validation logic for the parameter.
ParameterBuilder	label(String name) A custom human readable label for the parameter.
ParameterBuilder	largeText() Specifies that the parameter typically has large texts as a value
ParameterBuilder	matching(String regex) Sets a regular expression that must match for parameter values to be considered as valid.
ParameterBuilder	optional() Configures the parameter to be optional.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ParameterBuilder create(String name)

Creates a new builder for a parameter with the given name. The name is used to store and retrieve the parameter from the FeatureState.

See Also:

FeatureState.getParameter(String), FeatureState.setParameter(String, String)

label

public ParameterBuilder label(String name)

A custom human readable label for the parameter. If no custom label is set, the builder will use the name of the parameter as a label.

matching

public ParameterBuilder matching(String regex)

Sets a regular expression that must match for parameter values to be considered as valid.

optional

public ParameterBuilder optional()

Configures the parameter to be optional.

largeText

public ParameterBuilder largeText()

Specifies that the parameter typically has large texts as a value

description

public ParameterBuilder description(String description)

Sets an optional description for the parameter displayed in the admin console.

getName

public String getName()

Description copied from interface: Parameter

The name of the parameter. This name is used to store and retrieve the parameter from the FeatureState.

Specified by:

getName in interface Parameter

See Also:

FeatureState.getParameter(String), FeatureState.setParameter(String, String)

getLabel

public String getLabel()

Description copied from interface: Parameter

A human readable label that describes the parameter.

Specified by:

getLabel in interface Parameter

isValid

public boolean isValid(String value)

Description copied from interface: Parameter

This method allows to implement custom validation logic for the parameter.

Specified by:

isValid in interface Parameter

isOptional

public boolean isOptional()

Description copied from interface: Parameter

Returns true if the parameter is optional.

Specified by:

isOptional in interface Parameter

isLargeText

public boolean isLargeText()

Description copied from interface: Parameter

Returns true if the parameter value is typically large so that it should be displayed with an textarea instead of a simple text input field.

Specified by:

isLargeText in interface Parameter

getDescription

public String getDescription()

Description copied from interface: Parameter

An optional description of the parameter. Can return null, if no description exists.

Specified by:

getDescription in interface Parameter