From 7b41f242119da5e1c12d2f9b7ba8e2b0d3fd83cd Mon Sep 17 00:00:00 2001 From: Jane Petrovna Date: Tue, 22 Dec 2020 16:19:02 -0500 Subject: [PATCH] refactor config + modules use @Module annotation now --- src/main/java/pm/j4/kerosene/KeroseneMod.java | 21 ++--- .../j4/kerosene/gui/PModuleConfigEntry.java | 37 +++++++-- .../pm/j4/kerosene/gui/PModuleConfigPane.java | 7 +- .../gui/PModuleConfigurationWidget.java | 1 + .../java/pm/j4/kerosene/gui/POptionEntry.java | 4 +- .../pm/j4/kerosene/gui/POptionsScreen.java | 15 ++-- .../modules/bindings/BindingManager.java | 5 +- .../pm/j4/kerosene/util/config/Config.java | 1 - .../j4/kerosene/util/config/ConfigHolder.java | 1 - .../kerosene/util/config/ConfigManager.java | 78 ++++++++++++++----- .../kerosene/util/config/DefaultConfig.java | 2 - .../j4/kerosene/util/config/GlobalConfig.java | 5 +- .../pm/j4/kerosene/util/config/Module.java | 14 ++++ .../pm/j4/kerosene/util/config/Modules.java | 9 +++ .../pm/j4/kerosene/util/data/Category.java | 4 +- .../kerosene/util/data/ModInfoProvider.java | 18 +++-- .../j4/kerosene/util/module/ModuleBase.java | 34 ++++++-- .../util/module/option/BooleanOption.java | 14 +++- .../module/option/ConfigurationOption.java | 21 +++++ .../util/module/option/IntegerOption.java | 4 +- .../util/module/option/KeybindOption.java | 9 ++- .../util/module/option/ListOption.java | 4 +- .../util/module/option/StringOption.java | 4 +- 23 files changed, 220 insertions(+), 92 deletions(-) create mode 100644 src/main/java/pm/j4/kerosene/util/config/Module.java create mode 100644 src/main/java/pm/j4/kerosene/util/config/Modules.java diff --git a/src/main/java/pm/j4/kerosene/KeroseneMod.java b/src/main/java/pm/j4/kerosene/KeroseneMod.java index 4076895..c3eb1a0 100644 --- a/src/main/java/pm/j4/kerosene/KeroseneMod.java +++ b/src/main/java/pm/j4/kerosene/KeroseneMod.java @@ -3,41 +3,30 @@ package pm.j4.kerosene; import java.util.Optional; import net.fabricmc.api.ModInitializer; import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents; -import net.fabricmc.loader.api.FabricLoader; -import net.fabricmc.loader.api.ModContainer; import net.minecraft.client.options.KeyBinding; import pm.j4.kerosene.modules.ExampleModule; import pm.j4.kerosene.modules.bindings.BindingManager; import pm.j4.kerosene.util.config.ConfigHolder; import pm.j4.kerosene.util.config.ConfigManager; +import pm.j4.kerosene.util.config.Module; import pm.j4.kerosene.util.data.ModInfoProvider; import pm.j4.kerosene.util.module.ModuleBase; - /** * The type Kerosene mod. */ + +@Module(ExampleModule.class) +@Module(BindingManager.class) public class KeroseneMod implements ModInitializer { @Override public void onInitialize() { - ConfigManager.initConfig("kerosene"); - - // always update mod data - Optional modContainer = FabricLoader.getInstance().getModContainer("kerosene"); - modContainer.ifPresent(container -> ModInfoProvider.modData = container.getMetadata()); + ConfigManager.initConfig("kerosene", KeroseneMod.class); Optional conf = ConfigManager.getConfig("kerosene"); - try { - ModInfoProvider.registerMod(ExampleModule.class); - ModInfoProvider.registerMod(BindingManager.class); - } - catch (Exception e) { - System.out.println(e); - } - //initialize any keybinds, data, etc. ModInfoProvider.getRegisteredMods().forEach(ModuleBase::init); diff --git a/src/main/java/pm/j4/kerosene/gui/PModuleConfigEntry.java b/src/main/java/pm/j4/kerosene/gui/PModuleConfigEntry.java index a16baf2..e18de7d 100644 --- a/src/main/java/pm/j4/kerosene/gui/PModuleConfigEntry.java +++ b/src/main/java/pm/j4/kerosene/gui/PModuleConfigEntry.java @@ -32,13 +32,28 @@ public class PModuleConfigEntry extends ElementListWidget.Entry elements = new ArrayList<>(); + /** + * The Elements. + */ + private final List elements = new ArrayList<>(); - private String trueValue; - private String falseValue; + /** + * The True value. + */ + private final String trueValue; + /** + * The False value. + */ + private final String falseValue; + /** + * The Selected. + */ private Element selected; /** @@ -46,6 +61,7 @@ public class PModuleConfigEntry extends ElementListWidget.Entry { - button.setMessage(new LiteralText("Press any key...")); - }) { + new LiteralText(option.getStringValue().toUpperCase()), (button) -> button.setMessage(new LiteralText("Press any key..."))) { @Override public boolean keyPressed(int keyCode, int scanCode, int modifiers) { if (this.active && this.visible) { diff --git a/src/main/java/pm/j4/kerosene/gui/PModuleConfigPane.java b/src/main/java/pm/j4/kerosene/gui/PModuleConfigPane.java index a4a521d..5530d83 100644 --- a/src/main/java/pm/j4/kerosene/gui/PModuleConfigPane.java +++ b/src/main/java/pm/j4/kerosene/gui/PModuleConfigPane.java @@ -22,6 +22,9 @@ public class PModuleConfigPane extends ElementListWidget { */ private POptionEntry lastSelected; + /** + * The Selected config entry. + */ private PModuleConfigEntry selectedConfigEntry; /** @@ -82,8 +85,6 @@ public class PModuleConfigPane extends ElementListWidget { GlStateManager.DstFactor.ONE_MINUS_DST_ALPHA, GlStateManager.SrcFactor.ZERO, GlStateManager.DstFactor.ONE); - RenderSystem.disableAlphaTest(); - RenderSystem.shadeModel(7425); RenderSystem.disableTexture(); // darken config pane area @@ -111,8 +112,6 @@ public class PModuleConfigPane extends ElementListWidget { this.renderList(matrices, rl, sc, mouseX, mouseY, delta); RenderSystem.enableTexture(); - RenderSystem.shadeModel(7424); - RenderSystem.enableAlphaTest(); RenderSystem.disableBlend(); } } diff --git a/src/main/java/pm/j4/kerosene/gui/PModuleConfigurationWidget.java b/src/main/java/pm/j4/kerosene/gui/PModuleConfigurationWidget.java index 180a2f6..595e08b 100644 --- a/src/main/java/pm/j4/kerosene/gui/PModuleConfigurationWidget.java +++ b/src/main/java/pm/j4/kerosene/gui/PModuleConfigurationWidget.java @@ -19,6 +19,7 @@ import pm.j4.kerosene.util.module.ModuleBase; /** * The type P module configuration widget. */ +@SuppressWarnings("deprecation") public class PModuleConfigurationWidget extends AlwaysSelectedEntryListWidget { /** * The Parent. diff --git a/src/main/java/pm/j4/kerosene/gui/POptionEntry.java b/src/main/java/pm/j4/kerosene/gui/POptionEntry.java index 260e029..aa3a6b7 100644 --- a/src/main/java/pm/j4/kerosene/gui/POptionEntry.java +++ b/src/main/java/pm/j4/kerosene/gui/POptionEntry.java @@ -14,6 +14,7 @@ import pm.j4.kerosene.util.module.ModuleBase; /** * The type P option entry. */ +@SuppressWarnings("deprecation") public class POptionEntry extends AlwaysSelectedEntryListWidget.Entry { /** @@ -56,7 +57,7 @@ public class POptionEntry extends AlwaysSelectedEntryListWidget.Entry configurableModules = new ArrayList<>(); - configurableModules.addAll(ModInfoProvider.getRegisteredMods() - .stream().filter(ModuleBase::configurable) - .collect(Collectors.toList())); + List configurableModules = ModInfoProvider.getRegisteredMods() + .stream().filter(ModuleBase::configurable).collect(Collectors.toList()); configurableModules.forEach(module -> this.modules.addEntry(new POptionEntry(module, this.modules))); this.addButton(new ButtonWidget(this.width / 2 - 75, this.height - 30, 150, 20, ScreenTexts.DONE, (buttonWidget) -> { - ConfigManager.saveAllModules(); + ConfigManager.saveEverything(); assert this.client != null; this.client.openScreen(this.previousScreen); })); @@ -137,7 +136,7 @@ public class POptionsScreen extends Screen { trimmedName = StringVisitable.concat(textRenderer.trimToWidth(name, maxNameWidth - textRenderer.getWidth(ellipsis)), ellipsis); } if (mouseX > x + offset && mouseY > paneY + 1 && mouseY < paneY + 1 + textRenderer.fontHeight && mouseX < x + offset + textRenderer.getWidth(trimmedName)) { - //TODO tooltop + //TODO tooltip //selected.getModName() } textRenderer.draw(matrices, selected.getModName(), x + offset, paneY + 2 + lineSpacing, 0x808080); diff --git a/src/main/java/pm/j4/kerosene/modules/bindings/BindingManager.java b/src/main/java/pm/j4/kerosene/modules/bindings/BindingManager.java index edf2df1..bab431f 100644 --- a/src/main/java/pm/j4/kerosene/modules/bindings/BindingManager.java +++ b/src/main/java/pm/j4/kerosene/modules/bindings/BindingManager.java @@ -5,7 +5,6 @@ import net.minecraft.client.options.KeyBinding; import net.minecraft.client.util.InputUtil; import net.minecraft.text.TranslatableText; import org.lwjgl.glfw.GLFW; -import pm.j4.kerosene.KeroseneMod; import pm.j4.kerosene.gui.PModuleConfigEntry; import pm.j4.kerosene.gui.PModuleConfigPane; import pm.j4.kerosene.util.config.ConfigHolder; @@ -109,9 +108,7 @@ public class BindingManager extends ModuleBase { * @param b the b */ public static void removeBind(KeyBinding b) { - if(registeredBinds.contains(b)) { - registeredBinds.remove(b); - } + registeredBinds.remove(b); } /** diff --git a/src/main/java/pm/j4/kerosene/util/config/Config.java b/src/main/java/pm/j4/kerosene/util/config/Config.java index 3486e7f..c10f03b 100644 --- a/src/main/java/pm/j4/kerosene/util/config/Config.java +++ b/src/main/java/pm/j4/kerosene/util/config/Config.java @@ -2,7 +2,6 @@ package pm.j4.kerosene.util.config; import java.util.ArrayList; import java.util.List; -import pm.j4.kerosene.KeroseneMod; import pm.j4.kerosene.util.data.ModInfoProvider; import pm.j4.kerosene.util.module.ModuleBase; diff --git a/src/main/java/pm/j4/kerosene/util/config/ConfigHolder.java b/src/main/java/pm/j4/kerosene/util/config/ConfigHolder.java index d6a0f30..0244ac6 100644 --- a/src/main/java/pm/j4/kerosene/util/config/ConfigHolder.java +++ b/src/main/java/pm/j4/kerosene/util/config/ConfigHolder.java @@ -3,7 +3,6 @@ package pm.j4.kerosene.util.config; import java.util.List; import java.util.Map; import java.util.stream.Collectors; -import pm.j4.kerosene.KeroseneMod; import pm.j4.kerosene.util.data.ModInfoProvider; import pm.j4.kerosene.util.module.ModuleBase; diff --git a/src/main/java/pm/j4/kerosene/util/config/ConfigManager.java b/src/main/java/pm/j4/kerosene/util/config/ConfigManager.java index 033145c..b668035 100644 --- a/src/main/java/pm/j4/kerosene/util/config/ConfigManager.java +++ b/src/main/java/pm/j4/kerosene/util/config/ConfigManager.java @@ -3,11 +3,15 @@ package pm.j4.kerosene.util.config; import com.google.common.reflect.TypeToken; import com.google.gson.*; import java.io.*; +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; import java.lang.reflect.Type; import java.util.*; +import net.fabricmc.api.ModInitializer; import net.fabricmc.loader.api.FabricLoader; -import pm.j4.kerosene.KeroseneMod; +import pm.j4.kerosene.modules.ExampleModule; import pm.j4.kerosene.modules.bindings.BindingInfo; +import pm.j4.kerosene.modules.bindings.BindingManager; import pm.j4.kerosene.util.data.ModInfoProvider; import pm.j4.kerosene.util.data.ModuleConfig; import pm.j4.kerosene.util.data.OptionSerializiable; @@ -27,7 +31,7 @@ public class ConfigManager { /** * The constant config. */ - private static Map configs = new HashMap<>(); + private static final Map configs = new HashMap<>(); /** * Prepare config file. @@ -37,18 +41,36 @@ public class ConfigManager { * @return the file */ private static File prepareConfigFile(String path, String filename) { - if (path != "") { + if (!Objects.equals(path, "")) { File directory = new File(FabricLoader.getInstance().getConfigDir().toString(), path); - if (!directory.exists()) directory.mkdir(); + if (!directory.exists()) //noinspection ResultOfMethodCallIgnored + directory.mkdir(); } return new File(FabricLoader.getInstance().getConfigDir().toString(), path + filename); } /** * Init config. + * + * @param moduleName the module name */ - public static void initConfig(String moduleName) { + public static void initConfig(String moduleName, Class parent) { + try { + Annotation moduleAnnotation = parent.getAnnotation(Modules.class); + assert moduleAnnotation != null; + Module[] modules = ((Modules)moduleAnnotation).value(); + System.out.println(modules); + for (int i = 0; i < modules.length; i++) { + System.out.println(modules[i].value()); + ModInfoProvider.registerMod(modules[i].value()); + } + } + catch (Exception e) { + System.out.println(e); + } + System.out.println("init " + moduleName); if (configs.containsKey(moduleName)) { + System.out.println("contains " + configs.get(moduleName)); return; } @@ -56,22 +78,32 @@ public class ConfigManager { config.globalConfig = new DefaultConfig(); config.serverConfigs = new HashMap<>(); + System.out.println("load cfg"); config = load(moduleName + "/", moduleName +".json", ConfigHolder.class); - initModules(moduleName); + initModules(); + System.out.println("put cfg"); + configs.put(moduleName, config); } /** * Init modules. + * */ - public static void initModules(String moduleName) { + public static void initModules() { ModInfoProvider.getRegisteredMods().forEach(module -> { - ModuleConfig options = load(moduleName + "/modules/", module.getModuleName() + ".json", ModuleConfig.class); - if (options != null && options.options != null) { - options.options.forEach((key, option) -> { - if (module.hasOption(option.key)) { - module.setConfigOption(option.key, option.value); - } - }); + System.out.println("module" + module.getModuleName() + " initialized " + module.initialized); + if (!module.initialized) { + ModuleConfig options = load(module.getParent() + "/modules/", module.getModuleName() + ".json", ModuleConfig.class); + System.out.println("initialize " + module.getModuleName()); + if (options != null && options.options != null) { + options.options.forEach((key, option) -> { + if (module.hasOption(option.key)) { + System.out.println("setting " + option.key + " to " + option.value.getAsString()); + module.setConfigOption(option.key, option.value); + } + }); + } + module.initialized = true; } }); } @@ -147,7 +179,8 @@ public class ConfigManager { /** * Save module. * - * @param b the b + * @param modName the mod name + * @param b the b */ public static void saveModule(String modName, ModuleBase b) { ModuleConfig c = new ModuleConfig(); @@ -160,13 +193,13 @@ public class ConfigManager { */ public static void saveAllModules() { List mods = ModInfoProvider.getRegisteredMods(); - mods.forEach((module) -> { - ConfigManager.saveModule(module.getParent(), module); - }); + mods.forEach((module) -> ConfigManager.saveModule(module.getParent(), module)); } /** * Save global config. + * + * @param modName the mod name */ public static void saveGlobalConfig(String modName) { if(configs.containsKey(modName)) { @@ -174,9 +207,17 @@ public class ConfigManager { } } + public static void saveEverything() { + configs.keySet().forEach(key -> { + saveGlobalConfig(key); + }); + saveAllModules(); + } + /** * Gets config. * + * @param modName the mod name * @return the config */ public static Optional getConfig(String modName) { @@ -190,6 +231,7 @@ public class ConfigManager { /** * The type Serialization helper. */ +@SuppressWarnings("UnstableApiUsage") class SerializationHelper { /** diff --git a/src/main/java/pm/j4/kerosene/util/config/DefaultConfig.java b/src/main/java/pm/j4/kerosene/util/config/DefaultConfig.java index 956ff83..c7a2568 100644 --- a/src/main/java/pm/j4/kerosene/util/config/DefaultConfig.java +++ b/src/main/java/pm/j4/kerosene/util/config/DefaultConfig.java @@ -1,7 +1,5 @@ package pm.j4.kerosene.util.config; -import java.util.Collections; - /** * The type Default config. */ diff --git a/src/main/java/pm/j4/kerosene/util/config/GlobalConfig.java b/src/main/java/pm/j4/kerosene/util/config/GlobalConfig.java index 1c85477..c6af9ae 100644 --- a/src/main/java/pm/j4/kerosene/util/config/GlobalConfig.java +++ b/src/main/java/pm/j4/kerosene/util/config/GlobalConfig.java @@ -5,7 +5,6 @@ import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import net.minecraft.client.options.KeyBinding; import net.minecraft.client.util.InputUtil; -import pm.j4.kerosene.KeroseneMod; import pm.j4.kerosene.modules.bindings.BindingInfo; import pm.j4.kerosene.modules.bindings.BindingManager; import pm.j4.kerosene.util.data.ModInfoProvider; @@ -140,9 +139,7 @@ public class GlobalConfig extends Config { public static Map serializeModuleConfiguration(ModuleBase module) { Map opts = new HashMap<>(); Map configuration = module.getModuleConfiguration(); - configuration.forEach((key, value) -> { - opts.put(key, new OptionSerializiable(key, value.toJson())); - }); + configuration.forEach((key, value) -> opts.put(key, new OptionSerializiable(key, value.toJson()))); return opts; } diff --git a/src/main/java/pm/j4/kerosene/util/config/Module.java b/src/main/java/pm/j4/kerosene/util/config/Module.java new file mode 100644 index 0000000..f40476c --- /dev/null +++ b/src/main/java/pm/j4/kerosene/util/config/Module.java @@ -0,0 +1,14 @@ +package pm.j4.kerosene.util.config; + +import java.lang.annotation.Repeatable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.util.ArrayList; +import java.util.List; +import pm.j4.kerosene.util.module.ModuleBase; + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(Modules.class) +public @interface Module { + public Class value(); +} \ No newline at end of file diff --git a/src/main/java/pm/j4/kerosene/util/config/Modules.java b/src/main/java/pm/j4/kerosene/util/config/Modules.java new file mode 100644 index 0000000..26c6f93 --- /dev/null +++ b/src/main/java/pm/j4/kerosene/util/config/Modules.java @@ -0,0 +1,9 @@ +package pm.j4.kerosene.util.config; + +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +@Retention(RetentionPolicy.RUNTIME) +public @interface Modules { + Module[] value(); +} diff --git a/src/main/java/pm/j4/kerosene/util/data/Category.java b/src/main/java/pm/j4/kerosene/util/data/Category.java index 2e2392b..7ff488f 100644 --- a/src/main/java/pm/j4/kerosene/util/data/Category.java +++ b/src/main/java/pm/j4/kerosene/util/data/Category.java @@ -4,7 +4,6 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; -import pm.j4.kerosene.KeroseneMod; import pm.j4.kerosene.util.module.ModuleBase; /** @@ -26,8 +25,7 @@ public class Category { categoryMap.put(module.getCategory(), m); } else { List m = categoryMap.get(module.getCategory()); - List nm = new ArrayList<>(); - nm.addAll(m); + List nm = new ArrayList<>(m); nm.add(module); categoryMap.replace(module.getCategory(), nm); } diff --git a/src/main/java/pm/j4/kerosene/util/data/ModInfoProvider.java b/src/main/java/pm/j4/kerosene/util/data/ModInfoProvider.java index f061aac..28c0853 100644 --- a/src/main/java/pm/j4/kerosene/util/data/ModInfoProvider.java +++ b/src/main/java/pm/j4/kerosene/util/data/ModInfoProvider.java @@ -3,18 +3,15 @@ package pm.j4.kerosene.util.data; import java.util.ArrayList; import java.util.List; import java.util.Optional; -import net.fabricmc.loader.api.metadata.ModMetadata; import net.minecraft.client.MinecraftClient; -import net.minecraft.client.options.KeyBinding; import net.minecraft.server.integrated.IntegratedServer; import pm.j4.kerosene.util.module.ModuleBase; +/** + * The type Mod info provider. + */ //TODO refactor into multiple data holders public class ModInfoProvider { - /** - * The Mod data. - */ - public static ModMetadata modData = null; /** * The constant client. */ @@ -22,8 +19,15 @@ public class ModInfoProvider { /** * The constant activeMods. */ - private static List registeredMods = new ArrayList<>(); + private static final List registeredMods = new ArrayList<>(); + /** + * Register mod. + * + * @param mod the mod + * @throws IllegalAccessException the illegal access exception + * @throws InstantiationException the instantiation exception + */ public static void registerMod(Class mod) throws IllegalAccessException, InstantiationException { ModuleBase base = mod.newInstance(); if(!registeredMods.contains(base)) { diff --git a/src/main/java/pm/j4/kerosene/util/module/ModuleBase.java b/src/main/java/pm/j4/kerosene/util/module/ModuleBase.java index e9f69ea..b779d5b 100644 --- a/src/main/java/pm/j4/kerosene/util/module/ModuleBase.java +++ b/src/main/java/pm/j4/kerosene/util/module/ModuleBase.java @@ -19,6 +19,7 @@ public abstract class ModuleBase { * Instantiates a new Module base. * Parameters should be constant across restarts. * + * @param parent the parent * @param name The name of the module * @param category the category * @param activatable Whether a module can be activated, or if it will remain in the state it was upon startup @@ -60,11 +61,23 @@ public abstract class ModuleBase { config.ifPresent(configHolder -> configHolder.toggleModule(this.moduleName)); } + public boolean initialized; + + /** + * The Parent. + */ private final String parent; + + /** + * Gets parent. + * + * @return the parent + */ public String getParent() { return this.parent; } + /** * The Module's name. */ @@ -171,16 +184,19 @@ public abstract class ModuleBase { * * @param key the key * @param value the value - * @return whether the operation was successful. */ - public boolean setConfigOption(String key, JsonElement value) { + public void setConfigOption(String key, JsonElement value) { if (moduleOptions.containsKey(key)) { moduleOptions.get(key).fromJson(value); - return true; } - return false; } + /** + * Update config option. + * + * @param key the key + * @param option the option + */ public void updateConfigOption(String key, ConfigurationOption option) { System.out.println("update config option" + key + option.getStringValue()); System.out.println(moduleOptions.keySet()); @@ -209,12 +225,15 @@ public abstract class ModuleBase { return new ArrayList<>(); } + /** + * Convert default config map. + * + * @return the map + */ private Map convertDefaultConfig() { List options = this.getDefaultConfig(); Map mapped = new HashMap<>(); - options.forEach((option) -> { - mapped.put(option.getConfigKey(), option); - }); + options.forEach((option) -> mapped.put(option.getConfigKey(), option)); return mapped; } @@ -234,6 +253,7 @@ public abstract class ModuleBase { /** * Gets config entries. * + * @param sourcePane the source pane * @return the config entries */ public List getConfigEntries(PModuleConfigPane sourcePane) { diff --git a/src/main/java/pm/j4/kerosene/util/module/option/BooleanOption.java b/src/main/java/pm/j4/kerosene/util/module/option/BooleanOption.java index 885c3b9..43a7d65 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/BooleanOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/BooleanOption.java @@ -16,16 +16,28 @@ public class BooleanOption extends ConfigurationOption { /** * Instantiates a new Configuration option. * - * @param key + * @param key the key * @param description the description + * @param parent the parent */ public BooleanOption(String key, String description, ModuleBase parent) { super(key, description, parent); } + /** + * Gets value. + * + * @return the value + */ public boolean getValue() { return value; } + + /** + * Sets value. + * + * @param value the value + */ public void setValue(boolean value) { this.value = value; } @Override diff --git a/src/main/java/pm/j4/kerosene/util/module/option/ConfigurationOption.java b/src/main/java/pm/j4/kerosene/util/module/option/ConfigurationOption.java index 29a747b..04d1191 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/ConfigurationOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/ConfigurationOption.java @@ -11,19 +11,28 @@ public abstract class ConfigurationOption { * The Description. */ private final String description; + /** + * The Key. + */ private final String key; + /** + * The Parent. + */ private final ModuleBase parent; /** * Instantiates a new Configuration option. * + * @param key the key * @param description the description + * @param parent the parent */ public ConfigurationOption(String key, String description, ModuleBase parent) { this.description = description; this.key = key; this.parent = parent; } + /** * Gets description. * @@ -32,7 +41,19 @@ public abstract class ConfigurationOption { public final String getDescription() { return this.description; } + + /** + * Gets config key. + * + * @return the config key + */ public final String getConfigKey() { return key; } + + /** + * Gets parent. + * + * @return the parent + */ public final ModuleBase getParent() { return parent; } /** diff --git a/src/main/java/pm/j4/kerosene/util/module/option/IntegerOption.java b/src/main/java/pm/j4/kerosene/util/module/option/IntegerOption.java index 60ba90e..2e3b6b3 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/IntegerOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/IntegerOption.java @@ -16,9 +16,9 @@ public class IntegerOption extends ConfigurationOption { /** * Instantiates a new Configuration option. * - * @param key + * @param key the key * @param description the description - * @param parent + * @param parent the parent */ public IntegerOption(String key, String description, ModuleBase parent) { super(key, description, parent); diff --git a/src/main/java/pm/j4/kerosene/util/module/option/KeybindOption.java b/src/main/java/pm/j4/kerosene/util/module/option/KeybindOption.java index e99a8b7..43705b2 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/KeybindOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/KeybindOption.java @@ -24,14 +24,19 @@ public class KeybindOption extends ConfigurationOption { /** * Instantiates a new Configuration option. * - * @param key + * @param key the key * @param description the description - * @param parent + * @param parent the parent */ public KeybindOption(String key, String description, ModuleBase parent) { super(key, description, parent); } + /** + * Gets translation key. + * + * @return the translation key + */ public String getTranslationKey() { return value.getTranslationKey(); } diff --git a/src/main/java/pm/j4/kerosene/util/module/option/ListOption.java b/src/main/java/pm/j4/kerosene/util/module/option/ListOption.java index ff1d87b..8fcb110 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/ListOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/ListOption.java @@ -12,9 +12,9 @@ public class ListOption extends ConfigurationOption { /** * Instantiates a new Configuration option. * - * @param key + * @param key the key * @param description the description - * @param parent + * @param parent the parent */ public ListOption(String key, String description, ModuleBase parent) { super(key, description, parent); diff --git a/src/main/java/pm/j4/kerosene/util/module/option/StringOption.java b/src/main/java/pm/j4/kerosene/util/module/option/StringOption.java index b444708..d4e67bf 100644 --- a/src/main/java/pm/j4/kerosene/util/module/option/StringOption.java +++ b/src/main/java/pm/j4/kerosene/util/module/option/StringOption.java @@ -17,9 +17,9 @@ public class StringOption extends ConfigurationOption { /** * Instantiates a new Configuration option. * - * @param key + * @param key the key * @param description the description - * @param parent + * @param parent the parent */ public StringOption(String key, String description, ModuleBase parent) { super(key, description, parent);