Add EnvironmentSettings

Author: lucko

pom.xml

@@ -20,6 +20,17 @@
         <maven.test.skip>true</maven.test.skip>
     </properties>
 
+    <distributionManagement>
+        <snapshotRepository>
+            <id>luck-snapshots</id>
+            <url>https://nexus.lucko.me/repository/maven-snapshots/</url>
+        </snapshotRepository>
+        <repository>
+            <id>luck-releases</id>
+            <url>https://nexus.lucko.me/repository/maven-releases/</url>
+        </repository>
+    </distributionManagement>
+
     <dependencies>
         <dependency>
             <groupId>junit</groupId>

src/main/java/me/lucko/scriptcontroller/ScriptController.java

@@ -25,16 +25,13 @@
 
 package me.lucko.scriptcontroller;
 
-import me.lucko.scriptcontroller.bindings.BindingsSupplier;
 import me.lucko.scriptcontroller.environment.ScriptEnvironment;
-import me.lucko.scriptcontroller.environment.loader.ScriptLoadingExecutor;
+import me.lucko.scriptcontroller.environment.settings.EnvironmentSettings;
 import me.lucko.scriptcontroller.internal.ScriptControllerImpl;
 import me.lucko.scriptcontroller.logging.SystemLogger;
 
 import java.nio.file.Path;
 import java.util.Collection;
-import java.util.concurrent.Executor;
-import java.util.concurrent.TimeUnit;
 
 /**
  * Controls the execution and management of {@link ScriptEnvironment}s.
@@ -47,6 +44,7 @@ public interface ScriptController {
      * @return the builder
      */
     static Builder builder() {
+        //noinspection deprecation
         return ScriptControllerImpl.builder();
     }
 
@@ -61,11 +59,24 @@ static Builder builder() {
      * Sets up a new {@link ScriptEnvironment} in the given load directory.
      *
      * @param loadDirectory the directory
+     * @param settings the environment settings
      * @return the new environment
      * @throws UnsupportedOperationException if the controller does not support
      * setting up new environments after construction
      */
-    ScriptEnvironment setupNewEnvironment(Path loadDirectory);
+    ScriptEnvironment setupNewEnvironment(Path loadDirectory, EnvironmentSettings settings);
+
+    /**
+     * Sets up a new {@link ScriptEnvironment} in the given load directory.
+     *
+     * @param loadDirectory the directory
+     * @return the new environment
+     * @throws UnsupportedOperationException if the controller does not support
+     * setting up new environments after construction
+     */
+    default ScriptEnvironment setupNewEnvironment(Path loadDirectory) {
+        return setupNewEnvironment(loadDirectory, EnvironmentSettings.defaults());
+    }
 
     /**
      * Shuts down this script controller
@@ -77,23 +88,6 @@ static Builder builder() {
      */
     interface Builder {
 
-        /**
-         * Define the executor service used to setup task to poll scripts for
-         * changes and load new scripts.
-         *
-         * @param executor the executor
-         * @return this builder
-         */
-        Builder loadExecutor(ScriptLoadingExecutor executor);
-
-        /**
-         * Define the executor used to run scripts
-         *
-         * @param executor the executor
-         * @return this builder
-         */
-        Builder runExecutor(Executor executor);
-
         /**
          * Add a directory to be handled by this script controller
          *
@@ -103,29 +97,21 @@ interface Builder {
         Builder withDirectory(Path loadDirectory);
 
         /**
-         * Adds a bindings supplier to the controller
-         *
-         * @param supplier the bindings supplier
-         * @return this builder
-         */
-        Builder withBindings(BindingsSupplier supplier);
-
-        /**
-         * Define how often the script loader should poll scripts for updates
+         * Defines the logger to use.
          *
-         * @param time the time
-         * @param unit the unit
+         * @param logger the logger
          * @return this builder
          */
-        Builder pollRate(long time, TimeUnit unit);
+        Builder logger(SystemLogger logger);
 
         /**
-         * Defines the logger to use.
+         * Defines the default {@link EnvironmentSettings} to use when this
+         * controller creates new {@link ScriptEnvironment}s.
          *
-         * @param logger the logger
+         * @param settings the default settings
          * @return this builder
          */
-        Builder logger(SystemLogger logger);
+        Builder defaultEnvironmentSettings(EnvironmentSettings settings);
 
         /**
          * Builds a new {@link ScriptController} from the settings defined in

src/main/java/me/lucko/scriptcontroller/closable/AbstractWeakCompositeAutoClosable.java

@@ -45,16 +45,6 @@ static CompositeAutoClosable create() {
         return new AbstractCompositeAutoClosable();
     }
 
-    /**
-     * Creates a new standalone {@link CompositeAutoClosable}, which wrapped
-     * contained closables in {@link java.lang.ref.WeakReference}s.
-     *
-     * @return a new {@link CompositeAutoClosable}.
-     */
-    static CompositeAutoClosable createWeak() {
-        return new AbstractWeakCompositeAutoClosable();
-    }
-
     /**
      * Binds an {@link AutoCloseable} with this composite closable.
      *

src/main/java/me/lucko/scriptcontroller/closable/CompositeAutoClosable.java

@@ -28,6 +28,7 @@
 import me.lucko.scriptcontroller.ScriptController;
 import me.lucko.scriptcontroller.environment.loader.SystemScriptLoader;
 import me.lucko.scriptcontroller.environment.registry.ScriptRegistry;
+import me.lucko.scriptcontroller.environment.settings.EnvironmentSettings;
 import me.lucko.scriptcontroller.exports.ExportRegistry;
 
 import java.nio.file.Path;
@@ -47,6 +48,13 @@ public interface ScriptEnvironment extends AutoCloseable {
      */
     ScriptController getController();
 
+    /**
+     * Gets the environment settings
+     *
+     * @return the settings
+     */
+    EnvironmentSettings getSettings();
+
     /**
      * Gets the environments root scripts directory
      *

src/main/java/me/lucko/scriptcontroller/environment/ScriptEnvironment.java

@@ -0,0 +1,135 @@
+/*
+ * This file is part of scriptcontroller, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package me.lucko.scriptcontroller.environment.settings;
+
+import me.lucko.scriptcontroller.bindings.BindingsSupplier;
+import me.lucko.scriptcontroller.environment.ScriptEnvironment;
+import me.lucko.scriptcontroller.environment.loader.ScriptLoadingExecutor;
+import me.lucko.scriptcontroller.internal.ScriptControllerImpl;
+
+import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Represents the settings for a given {@link ScriptEnvironment}.
+ */
+public interface EnvironmentSettings {
+
+    /**
+     * Creates a new {@link Builder}.
+     *
+     * @return a new builder
+     */
+    static Builder builder() {
+        //noinspection deprecation
+        return ScriptControllerImpl.newSettingsBuilder();
+    }
+
+    /**
+     * Returns a default set of environment settings
+     *
+     * @return the default settings
+     */
+    static EnvironmentSettings defaults() {
+        //noinspection deprecation
+        return ScriptControllerImpl.defaultSettings();
+    }
+
+    /**
+     * Returns a builder encapsulating the properties already defined by this
+     * instance
+     *
+     * @return a builder
+     */
+    default Builder toBuilder() {
+        return builder().mergeSettingsFrom(this);
+    }
+
+    /**
+     * Builds {@link EnvironmentSettings}
+     */
+    interface Builder {
+
+        /**
+         * Applies the settings from the give instance to this builder
+         *
+         * @param other the other settings
+         * @return this builder
+         */
+        Builder mergeSettingsFrom(EnvironmentSettings other);
+
+        /**
+         * Define the executor service used to setup task to poll scripts for
+         * changes and load new scripts.
+         *
+         * @param executor the executor
+         * @return this builder
+         */
+        Builder loadExecutor(ScriptLoadingExecutor executor);
+
+        /**
+         * Define the executor used to run scripts
+         *
+         * @param executor the executor
+         * @return this builder
+         */
+        Builder runExecutor(Executor executor);
+
+        /**
+         * Adds a bindings supplier to the settings
+         *
+         * @param supplier the bindings supplier
+         * @return this builder
+         */
+        Builder withBindings(BindingsSupplier supplier);
+
+        /**
+         * Define how often the script loader should poll scripts for updates
+         *
+         * @param time the time
+         * @param unit the unit
+         * @return this builder
+         */
+        Builder pollRate(long time, TimeUnit unit);
+
+        /**
+         * Defines the init script for the environment
+         *
+         * @param path the path
+         * @return this builder
+         */
+        Builder initScript(String path);
+
+        /**
+         * Builds a new {@link EnvironmentSettings} instance.
+         *
+         * @return the resultant environment settings
+         */
+        EnvironmentSettings build();
+
+    }
+
+}