com.realtime.crossfire.jxclient.settings

Class Entry

java.lang.Object

com.realtime.crossfire.jxclient.settings.Entry

public class Entry
extends java.lang.Object

The value part of an entry of a settings file.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Entry

public Entry(@NotNull
             @NotNull java.lang.String value,
             @Nullable
             @Nullable java.lang.String documentation)

Creates a new instance.

Parameters:

value - the value

documentation - the documentation string or null if unknown

Method Detail

getValue

@NotNull
public @NotNull java.lang.String getValue()

Returns the value.

Returns:

the value

setValue

public void setValue(@NotNull
                     @NotNull java.lang.String value)

Sets the value.

Parameters:

value - the value

getDocumentation

@Nullable
public @Nullable java.lang.String getDocumentation()

Returns the documentation string.

Returns:

the documentation string or null if unknown

setDocumentation

public boolean setDocumentation(@Nullable
                                @Nullable java.lang.String documentation)

Sets the documentation string.

Parameters:

documentation - the documentation string or null if unknown

Returns:

whether the documentation string has changed