S
- The type of the implementing classT
- The type of the value
public interface SettingDefinition<S extends SettingDefinition<S,T>,T> extends Ordered<S>, Cloneable
SettingDefinitionProvider
,
SettingDefinitionGroup
,
SettingsManager
,
FileSettingDefinition
,
BooleanSettingDefinition
,
IntegerSettingDefinition
,
NumericSettingDefinition
,
StringSettingDefinition
,
Modifier and Type | Method and Description |
---|---|
T |
getDefaultValue() |
String |
getDescription() |
SettingDefinitionGroup |
getGroup() |
String |
getKey() |
String |
getTitle() |
SettingType |
getType() |
boolean |
hasDefaultValue() |
boolean |
hasDescription() |
boolean |
hasGroup() |
boolean |
hasTitle() |
boolean |
isOptional() |
S |
setDefaultValue(T defaultValue)
Sets the default value of this setting.
|
S |
setDescription(String description)
Sets the description of this setting definition, which should further
describe the purpose of this setting.
|
S |
setGroup(SettingDefinitionGroup group)
Sets the group of this definition.
|
S |
setKey(String key)
Sets the unique identifier of this setting definition, which can be
referenced by configurable classes.
|
S |
setOptional(boolean optional)
Sets whether this setting is optional or can be null.
|
S |
setTitle(String title)
Sets the title of this setting definition, which will be presented to the
user.
|
compareTo
String getKey()
String getTitle()
String getDescription()
boolean isOptional()
T getDefaultValue()
SettingDefinitionGroup getGroup()
boolean hasTitle()
boolean hasDescription()
boolean hasDefaultValue()
boolean hasGroup()
S setKey(String key)
key
- the unique keyS setTitle(String title)
title
- the titleS setDescription(String description)
description
- the descriptionS setOptional(boolean optional)
optional
- if this setting is optionalS setDefaultValue(T defaultValue)
defaultValue
- the default valueS setGroup(SettingDefinitionGroup group)
group
- the groupSettingType getType()
Copyright © 2012-2015 52north.org. All Rights Reserved.