Add LoggerProxy

Author: dualspiral

src/main/java/uk/co/drnaylor/quickstart/DefaultLogger.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of QuickStart Module Loader, licensed under the MIT License (MIT). See the LICENSE.txt file
+ * at the root of this project for more details.
+ */
+package uk.co.drnaylor.quickstart;
+
+import java.util.logging.Logger;
+
+public class DefaultLogger implements LoggerProxy {
+
+    public final static DefaultLogger INSTANCE = new DefaultLogger();
+
+    private DefaultLogger() {}
+
+    @Override
+    public void info(String message) {
+        Logger.getLogger("QuickStart").info(message);
+    }
+
+    @Override
+    public void warn(String message) {
+        Logger.getLogger("QuickStart").warning(message);
+    }
+
+    @Override
+    public void error(String message) {
+        Logger.getLogger("QuickStart").severe(message);
+    }
+}

src/main/java/uk/co/drnaylor/quickstart/LoggerProxy.java

@@ -0,0 +1,17 @@
+/*
+ * This file is part of QuickStart Module Loader, licensed under the MIT License (MIT). See the LICENSE.txt file
+ * at the root of this project for more details.
+ */
+package uk.co.drnaylor.quickstart;
+
+/**
+ * An interface that allows logging to occur with other frameworks.
+ */
+public interface LoggerProxy {
+
+    void info(String message);
+
+    void warn(String message);
+
+    void error(String message);
+}

src/main/java/uk/co/drnaylor/quickstart/ModuleContainer.java

@@ -25,9 +25,7 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
-import java.util.function.Consumer;
 import java.util.function.Predicate;
-import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 /**
@@ -80,17 +78,10 @@ public static ModuleContainer.Builder builder() {
      */
     private final ModuleConstructor constructor;
 
-    private final Consumer<Class<? extends Module>> modulePopulator = s -> {
-        // If we have a module annotation, we are golden.
-        if (s.isAnnotationPresent(ModuleData.class)) {
-            ModuleData md = s.getAnnotation(ModuleData.class);
-            discoveredModules.put(md.id().toLowerCase(), new ModuleSpec(s, md));
-        } else {
-            String id = s.getName().toLowerCase();
-            Logger.getLogger("QuickStart Module Loader").warning(MessageFormat.format("The module {0} does not have a ModuleData annotation associated with it. We're just assuming an ID of {0}.", id));
-            discoveredModules.put(id, new ModuleSpec(s, id, LoadingStatus.ENABLED, false));
-        }
-    };
+    /**
+     * The logger to use.
+     */
+    private final LoggerProxy loggerProxy;
 
     /**
      * Constructs a {@link ModuleContainer} and starts discovery of the modules.
@@ -101,13 +92,14 @@ public static ModuleContainer.Builder builder() {
      *
      * @throws QuickStartModuleDiscoveryException if there is an error starting the Module Container.
      */
-    private <N extends ConfigurationNode> ModuleContainer(ConfigurationLoader<N> configurationLoader, ClassLoader loader, String packageBase, ModuleConstructor constructor) throws QuickStartModuleDiscoveryException {
+    private <N extends ConfigurationNode> ModuleContainer(ConfigurationLoader<N> configurationLoader, ClassLoader loader, String packageBase, ModuleConstructor constructor, LoggerProxy loggerProxy) throws QuickStartModuleDiscoveryException {
 
         try {
-            this.config = new SystemConfig<>(configurationLoader);
+            this.config = new SystemConfig<>(configurationLoader, loggerProxy);
             this.constructor = constructor;
             this.classLoader = loader;
             this.packageLocation = packageBase;
+            this.loggerProxy = loggerProxy;
 
             discoverModules();
         } catch (Exception e) {
@@ -133,7 +125,17 @@ private void discoverModules() throws IOException, QuickStartModuleDiscoveryExce
         }
 
         // Put the modules into the discoverer.
-        modules.forEach(modulePopulator);
+        modules.forEach(s -> {
+            // If we have a module annotation, we are golden.
+            if (s.isAnnotationPresent(ModuleData.class)) {
+                ModuleData md = s.getAnnotation(ModuleData.class);
+                discoveredModules.put(md.id().toLowerCase(), new ModuleSpec(s, md));
+            } else {
+                String id = s.getName().toLowerCase();
+                loggerProxy.warn(MessageFormat.format("The module {0} does not have a ModuleData annotation associated with it. We're just assuming an ID of {0}.", id));
+                discoveredModules.put(id, new ModuleSpec(s, id, LoadingStatus.ENABLED, false));
+            }
+        });
 
         // Modules discovered. Create the Module Config adapter.
         Map<String, LoadingStatus> m = discoveredModules.entrySet().stream().filter(x -> !x.getValue().isMandatory())
@@ -149,11 +151,11 @@ private void discoverModules() throws IOException, QuickStartModuleDiscoveryExce
                 try {
                     discoveredModules.get(k).setStatus(v);
                 } catch (IllegalStateException ex) {
-                    Logger.getLogger("QuickStart").warning("A mandatory module can't have its status changed by config. Falling back to FORCELOAD for " + k);
+                    loggerProxy.warn("A mandatory module can't have its status changed by config. Falling back to FORCELOAD for " + k);
                 }
             });
         } catch (ObjectMappingException e) {
-            Logger.getLogger("QuickStart").warning("Could not load modules config, falling back to defaults.");
+            loggerProxy.warn("Could not load modules config, falling back to defaults.");
             e.printStackTrace();
         }
 
@@ -246,6 +248,7 @@ public void loadModules(boolean failOnOneError) throws QuickStartModuleLoaderExc
             } catch (Exception construction) {
                 construction.printStackTrace();
                 ms.setPhase(ModulePhase.ERRORED);
+                loggerProxy.error("The module " + ms.getModuleClass().getName() + " failed to construct.");
 
                 if (failOnOneError) {
                     currentPhase = ConstructionPhase.ERRORED;
@@ -288,6 +291,7 @@ public void loadModules(boolean failOnOneError) throws QuickStartModuleLoaderExc
                 construction.printStackTrace();
                 modules.remove(s);
                 ms.setPhase(ModulePhase.ERRORED);
+                loggerProxy.error("The module " + ms.getModuleClass().getName() + " failed to enable.");
 
                 if (failOnOneError) {
                     currentPhase = ConstructionPhase.ERRORED;
@@ -333,6 +337,7 @@ public static class Builder {
         private String packageToScan;
         private ModuleConstructor constructor;
         private ClassLoader classLoader;
+        private LoggerProxy loggerProxy;
 
         /**
          * Sets the {@link ConfigurationLoader} that will handle the module loading.
@@ -379,6 +384,17 @@ public Builder setClassLoader(ClassLoader classLoader) {
             return this;
         }
 
+        /**
+         * Sets the {@link LoggerProxy} to use for log messages.
+         *
+         * @param loggerProxy The logger proxy to use.
+         * @return This {@link Builder}, for chaining.
+         */
+        public Builder setLoggerProxy(LoggerProxy loggerProxy) {
+            this.loggerProxy = loggerProxy;
+            return this;
+        }
+
         /**
          * Builds a {@link ModuleContainer}.
          *
@@ -397,8 +413,12 @@ public ModuleContainer build() throws QuickStartModuleDiscoveryException {
                 classLoader = getClass().getClassLoader();
             }
 
-            Metadata.getStartupMessage().ifPresent(x -> Logger.getLogger("QuickStart").info(x));
-            return new ModuleContainer(configurationLoader, classLoader, packageToScan, constructor);
+            if (loggerProxy == null) {
+                loggerProxy = DefaultLogger.INSTANCE;
+            }
+
+            Metadata.getStartupMessage().ifPresent(x -> loggerProxy.info(x));
+            return new ModuleContainer(configurationLoader, classLoader, packageToScan, constructor, loggerProxy);
         }
     }
 

src/main/java/uk/co/drnaylor/quickstart/SystemConfig.java

@@ -22,17 +22,20 @@
 public final class SystemConfig<N extends ConfigurationNode, T extends ConfigurationLoader<N>> extends AbstractAdaptableConfig<N, T> {
 
     private final String modulesNode = "modules";
+    private final LoggerProxy proxy;
     private ModulesConfigAdapter configAdapter;
 
-    SystemConfig(T loader) throws IOException {
+    SystemConfig(T loader, LoggerProxy proxy) throws IOException {
         super(loader);
+        this.proxy = proxy;
     }
 
     void attachModulesConfig(Map<String, LoadingStatus> defaults) throws IOException {
         Preconditions.checkNotNull(defaults);
         Preconditions.checkState(configAdapter == null);
 
-        configAdapter = new ModulesConfigAdapter(new HashMap<>(defaults));
+        HashMap<String, LoadingStatus> h = new HashMap<>(defaults);
+        configAdapter = new ModulesConfigAdapter(h, proxy);
         this.attachConfigAdapter(modulesNode, configAdapter);
     }
 

src/main/java/uk/co/drnaylor/quickstart/config/ModulesConfigAdapter.java

@@ -8,10 +8,10 @@
 import com.google.common.reflect.TypeToken;
 import ninja.leaping.configurate.ConfigurationNode;
 import ninja.leaping.configurate.objectmapping.ObjectMappingException;
+import uk.co.drnaylor.quickstart.LoggerProxy;
 import uk.co.drnaylor.quickstart.enums.LoadingStatus;
 
 import java.util.HashMap;
-import java.util.logging.Logger;
 
 /**
  * Configuration adapter that handles the module statuses.
@@ -22,9 +22,11 @@ public final class ModulesConfigAdapter extends AbstractConfigAdapter<HashMap<St
 
     private final TypeToken<HashMap<String, LoadingStatus>> tt = new TypeToken<HashMap<String, LoadingStatus>>() {};
     private final HashMap<String, LoadingStatus> defaults;
+    private final LoggerProxy proxy;
 
-    public ModulesConfigAdapter(HashMap<String, LoadingStatus> defaults) {
+    public ModulesConfigAdapter(HashMap<String, LoadingStatus> defaults, LoggerProxy proxy) {
         this.defaults = defaults;
+        this.proxy = proxy;
     }
 
     @Override
@@ -43,7 +45,7 @@ protected HashMap<String, LoadingStatus> convertFromConfigurateNode(Configuratio
         try {
             value = node.getValue(new TypeToken<HashMap<String, LoadingStatus>>() {});
         } catch (ObjectMappingException e) {
-            Logger.getLogger("QuickStart").warning(e.getMessage());
+            proxy.warn(e.getMessage());
         }
 
         if (value == null) {

src/test/java/uk/co/drnaylor/quickstart/tests/tests/ModuleConfigurationAdapterTests.java

@@ -11,6 +11,7 @@
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
+import uk.co.drnaylor.quickstart.DefaultLogger;
 import uk.co.drnaylor.quickstart.SystemConfig;
 import uk.co.drnaylor.quickstart.config.ModulesConfigAdapter;
 import uk.co.drnaylor.quickstart.enums.LoadingStatus;
@@ -33,13 +34,13 @@ public void beforeTests() throws Exception {
 
         Constructor<?> ctor = SystemConfig.class.getDeclaredConstructors()[0];
         ctor.setAccessible(true);
-        config = (SystemConfig<ConfigurationNode, ConfigurationLoader<ConfigurationNode>>) ctor.newInstance(loader);
+        config = (SystemConfig<ConfigurationNode, ConfigurationLoader<ConfigurationNode>>) ctor.newInstance(loader, DefaultLogger.INSTANCE);
 
         HashMap<String, LoadingStatus> m = Maps.newHashMap();
         m.put("d", LoadingStatus.DISABLED);
         m.put("e", LoadingStatus.ENABLED);
         m.put("f", LoadingStatus.FORCELOAD);
-        config.attachConfigAdapter(ModulesConfigAdapter.modulesKey, new ModulesConfigAdapter(m));
+        config.attachConfigAdapter(ModulesConfigAdapter.modulesKey, new ModulesConfigAdapter(m, DefaultLogger.INSTANCE));
     }
 
     @Test