ScriptsLab
WikiDownloadsSourcesSupport
ScriptsLab
DocumentationDownloadsGitHubDiscord

© 2026 ScriptsLab

Back to src/main/java/com/scriptslab/core/module
J

BaseModule.java

Java · 199 lines · 4.9 KB

src/main/java/com/scriptslab/core/module/BaseModule.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package com.scriptslab.core.module;

import com.scriptslab.api.module.Module;
import com.scriptslab.api.module.ModuleDescriptor;

import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;

import java.io.File;
import java.nio.file.Path;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Logger;

/**
 * Abstract base implementation of Module.
 * Provides common functionality for all modules.
 */
public abstract class BaseModule implements Module {
    
    protected final ModuleDescriptor descriptor;
    protected final Path dataFolder;
    protected final Logger logger;
    protected final AtomicBoolean enabled;
    
    private FileConfiguration config;
    
    protected BaseModule(ModuleDescriptor descriptor, Path dataFolder) {
        this.descriptor = descriptor;
        this.dataFolder = dataFolder;
        this.logger = Logger.getLogger(getLoggerName());
        this.enabled = new AtomicBoolean(false);
        
        // Create data folder
        dataFolder.toFile().mkdirs();
    }
    
    @Override
    public String getId() {
        return descriptor.id();
    }
    
    @Override
    public String getName() {
        return descriptor.name();
    }
    
    @Override
    public String getVersion() {
        return descriptor.version();
    }
    
    @Override
    public ModuleDescriptor getDescriptor() {
        return descriptor;
    }
    
    @Override
    public Path getDataFolder() {
        return dataFolder;
    }
    
    @Override
    public FileConfiguration getConfig() {
        if (config == null) {
            loadConfig();
        }
        return config;
    }
    
    @Override
    public boolean isEnabled() {
        return enabled.get();
    }
    
    /**
     * Loads the module configuration.
     */
    protected void loadConfig() {
        File configFile = dataFolder.resolve("config.yml").toFile();
        
        if (!configFile.exists()) {
            // Create default config
            saveDefaultConfig();
        }
        
        config = YamlConfiguration.loadConfiguration(configFile);
    }
    
    /**
     * Saves the default configuration.
     * Override to provide default config values.
     */
    protected void saveDefaultConfig() {
        File configFile = dataFolder.resolve("config.yml").toFile();
        
        if (!configFile.exists()) {
            try {
                configFile.createNewFile();
                FileConfiguration defaultConfig = new YamlConfiguration();
                provideDefaultConfig(defaultConfig);
                defaultConfig.save(configFile);
            } catch (Exception e) {
                logger.warning("Failed to create default config: " + e.getMessage());
            }
        }
    }
    
    /**
     * Override to provide default configuration values.
     * 
     * @param config configuration to populate
     */
    protected void provideDefaultConfig(FileConfiguration config) {
        config.set("enabled", true);
    }
    
    /**
     * Saves the current configuration.
     */
    protected void saveConfig() {
        if (config != null) {
            try {
                File configFile = dataFolder.resolve("config.yml").toFile();
                config.save(configFile);
            } catch (Exception e) {
                logger.warning("Failed to save config: " + e.getMessage());
            }
        }
    }
    
    /**
     * Reloads the configuration.
     */
    protected void reloadConfig() {
        config = null;
        loadConfig();
    }
    
    /**
     * Logs an info message.
     */
    protected void log(String message) {
        logger.info(message);
    }
    
    /**
     * Logs a warning message.
     */
    protected void warn(String message) {
        logger.warning(message);
    }
    
    /**
     * Logs a severe message.
     */
    protected void error(String message) {
        logger.severe(message);
    }
    
    /**
     * Logs an error with exception.
     */
    protected void error(String message, Throwable throwable) {
        logger.severe(message);
        logger.severe(throwable.getMessage());
    }
    
    @Override
    public CompletableFuture<Void> onLoad() {
        return CompletableFuture.runAsync(() -> {
            log("Loading module...");
            loadConfig();
        });
    }
    
    @Override
    public CompletableFuture<Void> onEnable() {
        return CompletableFuture.runAsync(() -> {
            log("Enabling module...");
            enabled.set(true);
        });
    }
    
    @Override
    public CompletableFuture<Void> onDisable() {
        return CompletableFuture.runAsync(() -> {
            log("Disabling module...");
            enabled.set(false);
        });
    }
    
    @Override
    public String toString() {
        return String.format("Module{id=%s, name=%s, version=%s, enabled=%s}",
                getId(), getName(), getVersion(), isEnabled());
    }
}