|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Choice
Choice is the fundamental building block of the config system. Every Choice must be able to:
for license details.
The copyright to this program is held by it's authors.
Method Summary | |
---|---|
Class<? extends Object> |
getConversionClass()
The class that this Choice works on. |
String |
getFullPath()
The full path of the option. |
String |
getHelpText()
Gets a brief description of what is going on |
String |
getKey()
The key of the option. |
String |
getString()
String value to associate with the name (key) |
String |
getType()
The type by which UIs can pick an appropriate editor |
void |
init(org.jdom2.Element option,
ResourceBundle configResources)
String value to associate with the name (key) |
boolean |
isHidden()
Whether this should be visible in a Config Editor. |
boolean |
isIgnored()
Whether this should be ignored altogether in a Config Editor. |
boolean |
isSaveable()
Is this Choice OK to write out to a file, or should we use settings in this run of the program, but forget them for next time. |
boolean |
requiresRestart()
Do we need to restart the program in order for this change to have effect? |
void |
setFullPath(String fullPath)
Sets the full path of the option. |
void |
setHelpText(String helptext)
Sets a brief description of what is going on |
void |
setString(String value)
String value to associate with this Field. |
Method Detail |
---|
void init(org.jdom2.Element option, ResourceBundle configResources) throws StartupException
StartupException
String getKey()
String getFullPath()
void setFullPath(String fullPath)
fullPath
- The path string as supplied in config.propertiesString getType()
Class<? extends Object> getConversionClass()
String getString()
void setString(String value) throws ConfigException
value
- The new value for this Choice
ConfigException
String getHelpText()
void setHelpText(String helptext)
helptext
- Some help textboolean isSaveable()
boolean isHidden()
boolean isIgnored()
boolean requiresRestart()
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |