public static class Settings.SettingKey
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
SettingKey()
Construct a new empty setting key
|
SettingKey(java.lang.String key,
java.lang.String description,
java.lang.String toolTip)
Construct a new SettingKey with the given key, description and tool tip
text
|
SettingKey(java.lang.String key,
java.lang.String description,
java.lang.String toolTip,
java.util.List<java.lang.String> pickList)
Construct a new SettingKey with the given key, description, tool tip and
pick list
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object other)
Compares two setting keys for equality
|
java.lang.String |
getDescription()
Get the description (display name) of this setting
|
java.lang.String |
getKey()
Get the key of this setting
|
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Get the metadata for this setting
|
java.lang.String |
getMetadataElement(java.lang.String key)
Get a piece of metadata for this setting
|
java.lang.String |
getMetadataElement(java.lang.String key,
java.lang.String defaultValue)
Get a peice of metadata for this setting
|
java.util.List<java.lang.String> |
getPickList()
Get the optional pick list for the setting
|
java.lang.String |
getToolTip()
Get the tool tip text for this setting
|
int |
hashCode()
Hashcode based on the key
|
void |
setDescription(java.lang.String description)
Set the description (display name) of this setting
|
void |
setKey(java.lang.String key)
set the key of this setting
|
void |
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set the metadata for this setting
|
void |
setMetadataElement(java.lang.String key,
java.lang.String value)
Set the value of a piece of metadata for this setting
|
void |
setPickList(java.util.List<java.lang.String> pickList)
Set the optional pick list for the setting
|
void |
setToolTip(java.lang.String toolTip)
Set the tool tip text for this setting
|
java.lang.String |
toString()
Return the description (display name) of this setting
|
public SettingKey()
public SettingKey(java.lang.String key, java.lang.String description, java.lang.String toolTip)
key
- the key of this SettingKeydescription
- the description (display name of the setting)toolTip
- the tool tip text for the settingpublic SettingKey(java.lang.String key, java.lang.String description, java.lang.String toolTip, java.util.List<java.lang.String> pickList)
key
- the key of this SettingKeydescription
- the description (display name of the setting)toolTip
- the tool tip for the settingpickList
- an optional list of legal values for a string settingpublic void setKey(java.lang.String key)
key
- the key to usepublic java.lang.String getKey()
public void setDescription(java.lang.String description)
description
- the description of this settingpublic java.lang.String getDescription()
public void setToolTip(java.lang.String toolTip)
toolTip
- the tool tip text to usepublic java.lang.String getToolTip()
public void setMetadataElement(java.lang.String key, java.lang.String value)
key
- the key for the metadatavalue
- the value of the metadatapublic java.lang.String getMetadataElement(java.lang.String key)
key
- the key of the metadatapublic java.lang.String getMetadataElement(java.lang.String key, java.lang.String defaultValue)
key
- the key of the metadatadefaultValue
- the default value for the metadatapublic void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
metadata
- the metadata for this settingpublic java.util.Map<java.lang.String,java.lang.String> getMetadata()
public java.util.List<java.lang.String> getPickList()
public void setPickList(java.util.List<java.lang.String> pickList)
pickList
- the optional pick list for the setting (can be null if
not applicable)public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- the other setting key to compare topublic java.lang.String toString()
toString
in class java.lang.Object