Crossfire JXClient, Trunk  R20561
SettingsEntry.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff.
19  * Copyright (C) 2006-2011 Andreas Kirschbaum.
20  */
21 
22 package com.realtime.crossfire.jxclient.settings;
23 
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26 
33 public class SettingsEntry<T> {
34 
38  @NotNull
39  private final String key;
40 
44  @NotNull
45  private final T defaultValue;
46 
50  @Nullable
51  private final String comment;
52 
61  public SettingsEntry(@NotNull final String key, @NotNull final T defaultValue, @Nullable final String comment) {
62  this.key = key;
63  this.defaultValue = defaultValue;
64  this.comment = comment;
65  }
66 
71  @NotNull
72  public String getKey() {
73  return key;
74  }
75 
80  @NotNull
81  public T getDefaultValue() {
82  return defaultValue;
83  }
84 
89  @Nullable
90  public String getComment() {
91  return comment;
92  }
93 
94 }
final String key
The key in the settings file.
final String comment
The comment to add to the settings file.
String getKey()
Returns the key in the settings file.
String getComment()
Returns the command to add to the settings file.
SettingsEntry(@NotNull final String key, @NotNull final T defaultValue, @Nullable final String comment)
Creates a new instance.
T getDefaultValue()
Returns the default value if the key is missing from the settings file.
final T defaultValue
The default value if the key is missing from the settings file.