org.togglz.core.activation

Interface Parameter

All Known Implementing Classes:

ParameterBuilder

public interface Parameter

A parameter used to configure an ActivationStrategy. Users can either use ParameterBuilder for creating a parameter using a fluent API or implement the interface directly.

Author:

Christian Kaltepoth

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getName

String getName()

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

See Also:

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

getLabel

String getLabel()

A human readable label that describes the parameter.

getDescription

String getDescription()

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

isOptional

boolean isOptional()

Returns true if the parameter is optional.

isLargeText

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.

isValid

boolean isValid(String value)

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