Class Entry
- java.lang.Object
-
- com.realtime.crossfire.jxclient.settings.Entry
-
public class Entry extends java.lang.ObjectThe value part of an entry of a settings file.
-
-
Constructor Summary
Constructors Constructor Description Entry(@NotNull java.lang.String value, @Nullable java.lang.String documentation)Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @Nullable java.lang.StringgetDocumentation()Returns the documentation string.@NotNull java.lang.StringgetValue()Returns the value.booleansetDocumentation(@Nullable java.lang.String documentation)Sets the documentation string.voidsetValue(@NotNull java.lang.String value)Sets the value.
-
-
-
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
nullif unknown
-
setDocumentation
public boolean setDocumentation(@Nullable @Nullable java.lang.String documentation)Sets the documentation string.- Parameters:
documentation- the documentation string ornullif unknown- Returns:
- whether the documentation string has changed
-
-