com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry Class Reference

Pair of Option and corresponding documentation string. More...

Collaboration diagram for com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry:

Public Member Functions
String	getDocumentation ()
	Returns the corresponding documentation string. More...
Option	getOption ()
	Returns the Option instance. More...

Private Member Functions
	Entry (@NotNull final Option option, @NotNull final String documentation)
	Creates a new instance. More...

Private Attributes
final String	documentation
	The corresponding documentation string. More...
final Option	option
	The Option instance. More...

Detailed Description

Pair of Option and corresponding documentation string.

Author

Andreas Kirschbaum

Definition at line 149 of file OptionManager.java.

Constructor & Destructor Documentation

Entry()

com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.Entry ( @NotNull final Option  option, @NotNull final String  documentation  )

private

Creates a new instance.

Parameters

option	the option instance
documentation	the corresponding documentation string

Definition at line 168 of file OptionManager.java.

References com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.documentation, and com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.option.

Member Function Documentation

getDocumentation()

String com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getDocumentation

(

)

Returns the corresponding documentation string.

Returns

the corresponding documentation string

Definition at line 187 of file OptionManager.java.

References com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.documentation.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions().

Here is the caller graph for this function:

getOption()

Option com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getOption

(

)

Returns the Option instance.

Returns

the option instance

Definition at line 178 of file OptionManager.java.

References com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.option.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.getCheckBoxOption(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions().

Here is the caller graph for this function:

Member Data Documentation

documentation

final String com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.documentation

private

The corresponding documentation string.

Definition at line 161 of file OptionManager.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.Entry(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getDocumentation().

option

final Option com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.option

private

The Option instance.

Definition at line 155 of file OptionManager.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.Entry(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getOption().

---

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

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