T
- setting value type; it HAS to be an IMMUTABLE type (because returned values are by reference and are not cloned!)public interface ISetting<T>
Modifier and Type | Method and Description |
---|---|
void |
addChild(ISetting<?> setting)
Adds a child setting to this setting.
|
java.lang.String |
formatValue(T value)
Formats a value to a string.
|
T |
getDefaultValue()
Returns the default setting value.
|
java.lang.String |
getFullId()
Returns the full id including parent id (recursive).
|
ISettingsGroup |
getGroup()
Returns the settings group this setting belongs to (within a setting node page).
|
java.lang.String |
getId()
Returns the setting id.
|
java.lang.String |
getName()
Returns the setting name.
|
ISetting<?> |
getParent()
Returns the optional parent setting.
|
void |
getSettingPath(java.util.List<ISetting<?>> settingList)
Returns the setting path assembled in the specified list.
|
ISkillLevel |
getSkillLevel()
Returns the setting skill level.
|
IViewHints |
getViewHints()
Returns the view hints of the setting (always not null).
|
T |
parseValue(java.lang.String src)
Parses a value from a string representation.
|
java.util.Set<? extends ISetting<T>> |
selfSet()
Returns an unmodifiable set containing only
this . |
java.lang.String |
toString()
Returns the full id of the setting in the form of
"id:fullId" . |
void addChild(ISetting<?> setting)
setting
- child setting to be addedjava.util.Set<? extends ISetting<T>> selfSet()
this
.this
java.lang.String getId()
ISetting<?> getParent()
ISettingsGroup getGroup()
java.lang.String getFullId()
ISkillLevel getSkillLevel()
java.lang.String getName()
IViewHints getViewHints()
T getDefaultValue()
java.lang.String toString()
"id:fullId"
.toString
in class java.lang.Object
"id:fullId"
void getSettingPath(java.util.List<ISetting<?>> settingList)
The setting path is the list of settings starting from the root setting going down to this.
settingList
- list to assemble the setting path injava.lang.String formatValue(T value)
value
- value to be formattedT parseValue(java.lang.String src)
src
- source to parse the value fromnull
if src contains an invalid setting value
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.