Skip to content

Commit c07b4b1

Browse files
committed
Code review
1 parent 51eddbd commit c07b4b1

File tree

5 files changed

+38
-54
lines changed

5 files changed

+38
-54
lines changed

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin-common/src/main/java/dev/jorel/commandapi/config/BukkitConfigurationAdapter.java

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,7 @@
1414
import java.util.Set;
1515
import java.util.logging.Logger;
1616

17-
public class BukkitConfigurationAdapter extends ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> {
18-
19-
private final YamlConfiguration config;
20-
21-
public BukkitConfigurationAdapter(YamlConfiguration config) {
22-
this.config = config;
23-
}
17+
public record BukkitConfigurationAdapter(YamlConfiguration config) implements ConfigurationAdapter<YamlConfiguration> {
2418

2519
public static BukkitConfigurationAdapter createDummyInstance() {
2620
return new BukkitConfigurationAdapter(null);
@@ -93,7 +87,7 @@ public void tryCreateSection(String key) {
9387
}
9488

9589
@Override
96-
public ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> complete() {
90+
public ConfigurationAdapter<YamlConfiguration> complete() {
9791
String[] configStrings = config.saveToString().split("\n");
9892
StringBuilder configBuilder = new StringBuilder();
9993
for (String configString : configStrings) {
@@ -110,13 +104,9 @@ public ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> complete() {
110104
return this;
111105
}
112106

113-
@Override
114-
public YamlConfiguration config() {
115-
return config;
116-
}
117107

118108
@Override
119-
public ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> createNew() {
109+
public ConfigurationAdapter<YamlConfiguration> createNew() {
120110
return new BukkitConfigurationAdapter(new YamlConfiguration());
121111
}
122112

@@ -126,7 +116,7 @@ public DefaultBukkitConfig createDefaultConfig() {
126116
}
127117

128118
@Override
129-
public ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> loadFromFile(File file) {
119+
public ConfigurationAdapter<YamlConfiguration> loadFromFile(File file) {
130120
YamlConfiguration config = YamlConfiguration.loadConfiguration(file);
131121
return new BukkitConfigurationAdapter(config);
132122
}

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-test-tests/src/test/java/dev/jorel/commandapi/test/ConfigGenerationTests.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public void setup() {
6767
Map<String, CommentedSection> sections = new LinkedHashMap<>();
6868
sections.put("messages", messages);
6969

70-
ConfigurationAdapter<YamlConfiguration, DefaultBukkitConfig> adapter = new BukkitConfigurationAdapter(new YamlConfiguration());
70+
ConfigurationAdapter<YamlConfiguration> adapter = new BukkitConfigurationAdapter(new YamlConfiguration());
7171
bukkitConfig = DefaultBukkitConfig.create(options, sections);
7272
generator = ConfigGenerator.createNew(bukkitConfig);
7373
this.adapter = (BukkitConfigurationAdapter) generator.generate(adapter);
@@ -106,12 +106,11 @@ private void validateConfigOptionsAbsent(Set<String> options, BukkitConfiguratio
106106
}
107107

108108
private void validateSections(List<String> sections, String expectedOption, YamlConfiguration config) {
109-
ConfigurationSection root = config.getConfigurationSection(sections.get(0));
110-
assertNotNull(root, "Section '" + sections.get(0) + "' does not exist!");
109+
ConfigurationSection root = config;
111110

112-
for (int i = 1; i < sections.size(); i++) {
113-
root = root.getConfigurationSection(sections.get(i));
114-
assertNotNull(root, "Section '" + sections.get(i) + "' does not exist!");
111+
for (String section : sections) {
112+
root = root.getConfigurationSection(section);
113+
assertNotNull(root, "Section '" + section + "' does not exist!");
115114
}
116115
Object expectedValue = root.get(expectedOption);
117116
assertNotNull(expectedValue, "Expected option '" + expectedOption + "' was not found in section '" + root.getName() + "'!");

commandapi-platforms/commandapi-velocity/commandapi-velocity-plugin/src/main/java/dev/jorel/commandapi/config/VelocityConfigurationAdapter.java

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,7 @@
1111
import java.util.Set;
1212
import java.util.logging.Logger;
1313

14-
public class VelocityConfigurationAdapter extends ConfigurationAdapter<ConfigurationNode, DefaultVelocityConfig> {
15-
16-
private final YamlConfigurationLoader loader;
17-
private final CommentedConfigurationNode config;
18-
private final DefaultVelocityConfig defaultVelocityConfig;
19-
20-
public VelocityConfigurationAdapter(YamlConfigurationLoader loader, CommentedConfigurationNode config, DefaultVelocityConfig defaultVelocityConfig) {
21-
this.loader = loader;
22-
this.config = config;
23-
this.defaultVelocityConfig = defaultVelocityConfig;
24-
}
14+
public record VelocityConfigurationAdapter(YamlConfigurationLoader loader, CommentedConfigurationNode config, DefaultVelocityConfig defaultVelocityConfig) implements ConfigurationAdapter<ConfigurationNode> {
2515

2616
public static VelocityConfigurationAdapter createDummyInstance(YamlConfigurationLoader loader) {
2717
return new VelocityConfigurationAdapter(loader, null, null);
@@ -78,12 +68,12 @@ public CommentedConfigurationNode config() {
7868
}
7969

8070
@Override
81-
public ConfigurationAdapter<ConfigurationNode, DefaultVelocityConfig> complete() {
71+
public ConfigurationAdapter<ConfigurationNode> complete() {
8272
return this;
8373
}
8474

8575
@Override
86-
public ConfigurationAdapter<ConfigurationNode, DefaultVelocityConfig> createNew() {
76+
public ConfigurationAdapter<ConfigurationNode> createNew() {
8777
return new VelocityConfigurationAdapter(loader, loader.createNode(), createDefaultConfig());
8878
}
8979

@@ -93,7 +83,7 @@ public DefaultVelocityConfig createDefaultConfig() {
9383
}
9484

9585
@Override
96-
public ConfigurationAdapter<ConfigurationNode, DefaultVelocityConfig> loadFromFile(File file) throws IOException {
86+
public ConfigurationAdapter<ConfigurationNode> loadFromFile(File file) throws IOException {
9787
return new VelocityConfigurationAdapter(loader, loader.load(), createDefaultConfig());
9888
}
9989

commandapi-plugin/src/main/java/dev/jorel/commandapi/config/ConfigGenerator.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ public static ConfigGenerator createNew(DefaultConfig defaultConfig) {
1616
return new ConfigGenerator(defaultConfig);
1717
}
1818

19-
public <T, C extends DefaultConfig> ConfigurationAdapter<T, C> generate(ConfigurationAdapter<T, C> existingConfig) {
20-
ConfigurationAdapter<T, C> updatedConfig = existingConfig.createNew();
19+
public <T> ConfigurationAdapter<T> generate(ConfigurationAdapter<T> existingConfig) {
20+
ConfigurationAdapter<T> updatedConfig = existingConfig.createNew();
2121

2222
boolean shouldRemoveValues = shouldRemoveOptions(existingConfig);
2323

@@ -61,7 +61,7 @@ public <T, C extends DefaultConfig> ConfigurationAdapter<T, C> generate(Configur
6161
return (wasConfigUpdated) ? updatedConfig.complete() : null;
6262
}
6363

64-
private <T, C extends DefaultConfig> boolean shouldRemoveOptions(ConfigurationAdapter<T, C> config) {
64+
private <T> boolean shouldRemoveOptions(ConfigurationAdapter<T> config) {
6565
Set<String> configOptions = config.getKeys();
6666
Set<String> defaultConfigOptions = defaultConfig.getAllOptions().keySet();
6767

commandapi-plugin/src/main/java/dev/jorel/commandapi/config/ConfigurationAdapter.java

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,37 @@
55
import java.util.Set;
66
import java.util.logging.Logger;
77

8-
public abstract class ConfigurationAdapter<Configuration, DefaultConfig extends dev.jorel.commandapi.config.DefaultConfig> {
8+
public interface ConfigurationAdapter<Configuration> {
99

10-
public abstract void setValue(String key, Object value);
10+
void setValue(String key, Object value);
1111

12-
public abstract void setComment(String key, String[] comment);
12+
void setComment(String key, String[] comment);
1313

14-
public abstract Object getValue(String key);
14+
Object getValue(String key);
1515

16-
public abstract String[] getComment(String key);
16+
String[] getComment(String key);
1717

18-
public abstract Set<String> getKeys();
18+
Set<String> getKeys();
1919

20-
public abstract boolean contains(String key);
20+
boolean contains(String key);
2121

22-
public abstract void tryCreateSection(String key);
22+
void tryCreateSection(String key);
2323

24-
public abstract ConfigurationAdapter<Configuration, DefaultConfig> complete();
24+
ConfigurationAdapter<Configuration> complete();
2525

26-
public abstract Configuration config();
26+
Configuration config();
2727

28-
public abstract ConfigurationAdapter<Configuration, DefaultConfig> createNew();
28+
ConfigurationAdapter<Configuration> createNew();
2929

30-
public abstract DefaultConfig createDefaultConfig();
30+
DefaultConfig createDefaultConfig();
3131

32-
public abstract ConfigurationAdapter<Configuration, DefaultConfig> loadFromFile(File file) throws IOException;
32+
ConfigurationAdapter<Configuration> loadFromFile(File file) throws IOException;
3333

34-
public abstract void saveToFile(File file) throws IOException;
34+
void saveToFile(File file) throws IOException;
3535

36-
public void saveDefaultConfig(File directory, File configFile, Logger logger) {
36+
default void saveDefaultConfig(File directory, File configFile, Logger logger) {
3737
ConfigGenerator generator = ConfigGenerator.createNew(createDefaultConfig());
38-
ConfigurationAdapter<Configuration, DefaultConfig> existingConfig;
38+
ConfigurationAdapter<Configuration> existingConfig;
3939
if (!directory.exists()) {
4040
if (!directory.mkdirs()) {
4141
logger.severe("Failed to create directory for the CommandAPI's config.yml file!");
@@ -46,10 +46,15 @@ public void saveDefaultConfig(File directory, File configFile, Logger logger) {
4646
existingConfig = loadFromFile(configFile);
4747
} catch (IOException e) {
4848
logger.severe("Failed to load the config file!");
49+
logger.severe("Error message: " + e.getMessage());
50+
logger.severe("Stacktrace:");
51+
for (StackTraceElement element : e.getStackTrace()) {
52+
logger.severe(element.toString());
53+
}
4954
return;
5055
}
5156
}
52-
ConfigurationAdapter<Configuration, DefaultConfig> updatedConfig = generator.generate(existingConfig);
57+
ConfigurationAdapter<Configuration> updatedConfig = generator.generate(existingConfig);
5358
if (updatedConfig == null) {
5459
return;
5560
}

0 commit comments

Comments
 (0)