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

The value part of an entry of a settings file. More...

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

Public Member Functions
	Entry (@NotNull final String value, @Nullable final String documentation)
	Creates a new instance. More...
String	getDocumentation ()
	Returns the documentation string. More...
String	getValue ()
	Returns the value. More...
void	setDocumentation (@Nullable final String documentation)
	Sets the documentation string. More...
void	setValue (@NotNull final String value)
	Sets the value. More...

Private Attributes
String	documentation
	The documentation string or. More...
String	value
	The value. More...

Detailed Description

The value part of an entry of a settings file.

Author

Andreas Kirschbaum

Definition at line 31 of file Entry.java.

Constructor & Destructor Documentation

Entry()

com.realtime.crossfire.jxclient.settings.Entry.Entry	(	@NotNull final String	value,
		@Nullable final String	documentation
	)

Creates a new instance.

Parameters

value	the value
documentation	the documentation string or null if unknown

Definition at line 50 of file Entry.java.

References com.realtime.crossfire.jxclient.settings.Entry.documentation, and com.realtime.crossfire.jxclient.settings.Entry.value.

Member Function Documentation

getDocumentation()

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

(

)

Returns the documentation string.

Returns

the documentation string or

null 

if unknown

Definition at line 77 of file Entry.java.

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

Referenced by com.realtime.crossfire.jxclient.settings.Settings.saveNode().

Here is the caller graph for this function:

getValue()

String com.realtime.crossfire.jxclient.settings.Entry.getValue

(

)

Returns the value.

Returns

the value

Definition at line 60 of file Entry.java.

References com.realtime.crossfire.jxclient.settings.Entry.value.

Referenced by com.realtime.crossfire.jxclient.settings.Settings.getString(), com.realtime.crossfire.jxclient.settings.Settings.putString(), and com.realtime.crossfire.jxclient.settings.Settings.saveNode().

Here is the caller graph for this function:

setDocumentation()

void com.realtime.crossfire.jxclient.settings.Entry.setDocumentation

(

@Nullable final String

documentation

)

Sets the documentation string.

Parameters

documentation

the documentation string or null if unknown

Definition at line 85 of file Entry.java.

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

Referenced by com.realtime.crossfire.jxclient.settings.Settings.putString().

Here is the caller graph for this function:

setValue()

void com.realtime.crossfire.jxclient.settings.Entry.setValue

(

@NotNull final String

value

)

Sets the value.

Parameters

value

the value

Definition at line 68 of file Entry.java.

References com.realtime.crossfire.jxclient.settings.Entry.value.

Referenced by com.realtime.crossfire.jxclient.settings.Settings.putString().

Here is the caller graph for this function:

Member Data Documentation

documentation

String com.realtime.crossfire.jxclient.settings.Entry.documentation

private

The documentation string or.

null 

if unknown.

Definition at line 43 of file Entry.java.

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

value

String com.realtime.crossfire.jxclient.settings.Entry.value

private

The value.

Definition at line 37 of file Entry.java.

Referenced by com.realtime.crossfire.jxclient.settings.Entry.Entry(), com.realtime.crossfire.jxclient.settings.Entry.getValue(), and com.realtime.crossfire.jxclient.settings.Entry.setValue().

---

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

• crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/settings/Entry.java