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

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

Public Member Functions
	Entry (@NotNull final String value, @Nullable final String documentation)
String	getDocumentation ()
String	getValue ()
boolean	setDocumentation (@Nullable final String documentation)
void	setValue (@NotNull final String value)

Private Attributes
String	documentation
String	value

Detailed Description

The value part of an entry of a settings file.

Author

Andreas Kirschbaum

Definition at line 32 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 51 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 78 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 61 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()

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

(

@Nullable final String

documentation

)

Sets the documentation string.

Parameters

documentation

the documentation string or null if unknown

Returns

whether the documentation string has changed

Definition at line 87 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 69 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 44 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 38 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:

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