Configuration API

Option and OptionSet

This is recursive element, the option set can contain several options, and an option can contain several optionSet, but the final configuration is contained in the option class, so the option will be described, since the optionSet is basically a collection of option there is no much to say about it.

 

See also Configuration

 Field name  Description
 value  the value of the configuration option
 name  the name of the configured option
 defaultValue the default value for that option in case the user does not configure it
explanation a brief description of the purpose of the option
validationRegExp a regular expression that validates the value the user gives to the option that check if the introduced value is correct or not
mandatory flag that tells if the option is mandatory or not
type the type of option, it can be NORMAL or PASSWORD, if it password the UI will hide the value

Example:

{
   "name":"HtmlWidth",
   "defaultValue":"0",
   "explanation":"",
   "value":"0",
   "type":"NORMAL",
   "mandatory":true
}