|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=FIELD) @Retention(value=RUNTIME) public @interface BooleanProperty
Indicates that a field in an PipelineComponentConfiguration
is a Boolean
configuration property. Use this annotation with PipelineComponentConfiguration
member variables of type primitive boolean or java.lang.Boolean.
The CAS Server automatically validates all configuration property constraints such as isRequired.
Here is an example usage of the @BooleanProperty annotation with all parameters:
@BooleanProperty(name="myBoolean" displayName="My Boolean", description="My Boolean description", defaultValue="true", isRequired=true, isAlwaysVisible=true, configGroup="Basic Options" ) private Boolean myBooleanField;
Required Element Summary | |
---|---|
String |
defaultValue
The default value for the property. |
Optional Element Summary | |
---|---|
String |
configGroup
The name of the ConfigurationGroup this configuration property
belongs to. |
String |
description
A description of the configuration property. |
String |
displayName
The display name of the configuration property shown in CAS Console. |
boolean |
isAlwaysVisible
Indicates whether or not to show the configuration property in the CAS Console even if the configuration property is not required. |
boolean |
isRequired
Indicates whether or not the property is required. |
String |
name
The name of the configuration property. |
Element Detail |
---|
public abstract String defaultValue
public abstract String name
public abstract boolean isRequired
public abstract String description
public abstract String displayName
public abstract boolean isAlwaysVisible
public abstract String configGroup
ConfigurationGroup
this configuration property
belongs to. This must correspond to a ConfigGroup annotation on the
PipelineComponentConfiguration
. Alternatively the ConfigGroup can
be specified using the ConfigurationGroup.propertyOrder()
annotation parameter.
ConfigurationGroup
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |