Package org.togglz.core.activation
Interface Parameter
-
- All Known Implementing Classes:
ParameterBuilder
public interface ParameterA parameter used to configure anActivationStrategy. Users can either useParameterBuilderfor creating a parameter using a fluent API or implement the interface directly.- Author:
- Christian Kaltepoth
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()An optional description of the parameter.StringgetLabel()A human readable label that describes the parameter.StringgetName()The name of the parameter.booleanisLargeText()Returnstrueif the parameter value is typically large so that it should be displayed with an textarea instead of a simple text input field.booleanisOptional()Returnstrueif the parameter is optional.booleanisValid(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 theFeatureState.
-
getLabel
String getLabel()
A human readable label that describes the parameter.
-
getDescription
String getDescription()
An optional description of the parameter. Can returnnull, if no description exists.
-
isOptional
boolean isOptional()
Returnstrueif the parameter is optional.
-
isLargeText
boolean isLargeText()
Returnstrueif 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.
-
-