Package com.realtime.crossfire.jxclient.settings

Class Entry

java.lang.Object

com.realtime.crossfire.jxclient.settings.Entry

public class Entry
extends Object

The value part of an entry of a settings file.

Constructor Summary

Constructors

Constructor	Description
Entry(@NotNull String value, @Nullable String documentation)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getDocumentation()	Returns the documentation string.
@NotNull String	getValue()	Returns the value.
boolean	setDocumentation(@Nullable String documentation)	Sets the documentation string.
void	setValue(@NotNull String value)	Sets the value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Entry

public Entry(@NotNull
 @NotNull String value,
 @Nullable
 @Nullable String documentation)

Creates a new instance.

Parameters:

value - the value

documentation - the documentation string or null if unknown

Method Details

getValue

@NotNull
public @NotNull String getValue()

Returns the value.

Returns:

the value

setValue

public void setValue(@NotNull
 @NotNull String value)

Sets the value.

Parameters:

value - the value

getDocumentation

@Nullable
public @Nullable String getDocumentation()

Returns the documentation string.

Returns:

the documentation string or null if unknown

setDocumentation

public boolean setDocumentation(@Nullable
 @Nullable String documentation)

Sets the documentation string.

Parameters:

documentation - the documentation string or null if unknown

Returns:

whether the documentation string has changed