summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java')
-rw-r--r--Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java106
1 files changed, 106 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java b/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java
new file mode 100644
index 00000000000..f3868b488f5
--- /dev/null
+++ b/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/controller/ConfigurationController.java
@@ -0,0 +1,106 @@
+/**
+ * Arara, the cool TeX automation tool
+ * Copyright (c) 2012 -- 2018, Paulo Roberto Massa Cereda
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the project's author nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+ * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.github.cereda.arara.controller;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Implements the configuration controller. The idea here is to provide a map
+ * that holds all configuration settings used by model and utilitary classes
+ * throughout the execution. This controller is implemented as a singleton.
+ * @author Paulo Roberto Massa Cereda
+ * @version 4.0
+ * @since 4.0
+ */
+public class ConfigurationController {
+
+ // the controller itself, since we have a singleton;
+ // this is the reference instance, instantiated once
+ private static final ConfigurationController instance =
+ new ConfigurationController();
+
+ // the configuration settings are stored in a map;
+ // pretty much everything can be stored in this map,
+ // as long as you know what to retrieve later on
+ private final Map<String, Object> map;
+
+ /**
+ * Private constructor. Called once for creating the proper singleton.
+ */
+ private ConfigurationController() {
+ map = new HashMap<String, Object>();
+ }
+
+ /**
+ * Gets the current configuration controller. Since this class is
+ * implemented as a singleton, you will get the same controller every
+ * single time, and that's good.
+ * @return The configuration controller, which hold the settings map.
+ */
+ public static ConfigurationController getInstance() {
+ return instance;
+ }
+
+ /**
+ * Returns the object indexed by the provided key. This method provides an
+ * easy access to the underlying map.
+ * @param key A string representing the key.
+ * @return An object indexed by the provided key.
+ */
+ public Object get(String key) {
+ return map.get(key);
+ }
+
+ /**
+ * Puts the object in the map and indexes it in the provided key. This
+ * method provides an easy access to the underlying map.
+ * @param key A string representing the key.
+ * @param value The object to be indexed by the provided key.
+ */
+ public void put(String key, Object value) {
+ map.put(key, value);
+ }
+
+ /**
+ * Checks if the map contains the provided key. This is actually a wrapper
+ * to the private map's method of the same name.
+ * @param key The key to be checked.
+ * @return A boolean value indicating if the map contains the provided key.
+ */
+ public boolean contains(String key) {
+ return map.containsKey(key);
+ }
+
+}