com.realtime.crossfire.jxclient.settings.SettingsEntry< T > Class Template Reference

Inheritance diagram for com.realtime.crossfire.jxclient.settings.SettingsEntry< T >:

Collaboration diagram for com.realtime.crossfire.jxclient.settings.SettingsEntry< T >:

Public Member Functions
String	getComment ()
T	getDefaultValue ()
String	getKey ()
	SettingsEntry (@NotNull final String key, @NotNull final T defaultValue, @Nullable final String comment)

Private Attributes
final String	comment
final T	defaultValue
final String	key

Detailed Description

An entry in the settings file. It consists of a key/value pair and a comment that explains the entry.

Parameters

<T>	the type of the values

Author

Andreas Kirschbaum

Definition at line 34 of file SettingsEntry.java.

Constructor & Destructor Documentation

SettingsEntry()

com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.SettingsEntry	(	@NotNull final String	key,
		@NotNull final T	defaultValue,
		@Nullable final String	comment
	)

Creates a new instance.

Parameters

key	the key in the settings file
defaultValue	the default value if the key is missing from the settings file
comment	the comment to add to the settings file or null if unknown

Definition at line 62 of file SettingsEntry.java.

Member Function Documentation

getComment()

String com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.getComment

(

)

Returns the command to add to the settings file.

Returns

the comment or

null 

if unknown

Definition at line 91 of file SettingsEntry.java.

getDefaultValue()

T com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.getDefaultValue

(

)

Returns the default value if the key is missing from the settings file.

Returns

the default value

Definition at line 82 of file SettingsEntry.java.

getKey()

String com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.getKey

(

)

Returns the key in the settings file.

Returns

the key

Definition at line 73 of file SettingsEntry.java.

Member Data Documentation

comment

final String com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.comment

private

The comment to add to the settings file. Set to

null 

if unknown.

Definition at line 52 of file SettingsEntry.java.

Referenced by com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.getComment(), and com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.SettingsEntry().

defaultValue

final T com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.defaultValue

private

The default value if the key is missing from the settings file.

Definition at line 46 of file SettingsEntry.java.

Referenced by com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.getDefaultValue(), and com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.SettingsEntry().

key

final String com.realtime.crossfire.jxclient.settings.SettingsEntry< T >.key

private

The key in the settings file.

Definition at line 40 of file SettingsEntry.java.

Referenced by com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.getKey(), and com.realtime.crossfire.jxclient.settings.SettingsEntry< Boolean >.SettingsEntry().

---

The documentation for this class was generated from the following file:

• src/gui/src/main/java/com/realtime/crossfire/jxclient/settings/SettingsEntry.java