Introduce interfaces for identities/configmanagers

Change-Id: If8ead3ae7d8c4997d6735b9ffa871f699bceed27
Reviewed-on: http://gerrit.dmdirc.com/2752
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/config/ConfigManager.java

 
 package com.dmdirc.config;
 
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.util.collections.MapList;
 import com.dmdirc.util.validators.Validator;
 @Slf4j
 @SuppressWarnings("PMD.UnusedPrivateField")
 public class ConfigManager extends ConfigSource implements ConfigChangeListener,
-        IdentityListener {
+        IdentityListener, AggregateConfigProvider {
 
     /** Temporary map for lookup stats. */
-    private static final Map<String, Integer> STATS = new TreeMap<String, Integer>();
+    private static final Map<String, Integer> STATS = new TreeMap<>();
 
     /** Magical domain to redirect to the version identity. */
     private static final String VERSION_DOMAIN = "version";
     private final List<Identity> sources;
 
     /** The listeners registered for this manager. */
-    private final MapList<String, ConfigChangeListener> listeners
-            = new MapList<String, ConfigChangeListener>();
+    private final MapList<String, ConfigChangeListener> listeners = new MapList<>();
 
     /** The config binder to use for this manager. */
     @Getter
         return false;
     }
 
-    /**
-     * Returns the name of all the options in the specified domain. If the
-     * domain doesn't exist, an empty list is returned.
-     *
-     * @param domain The domain to search
-     * @return A list of options in the specified domain
-     */
+    /** {@inheritDoc} */
+    @Override
     public Map<String, String> getOptions(final String domain) {
         if (VERSION_DOMAIN.equals(domain)) {
             return IdentityManager.getIdentityManager()
                     .getGlobalVersionIdentity().getOptions(domain);
         }
 
-        final Map<String, String> res = new HashMap<String, String>();
+        final Map<String, String> res = new HashMap<>();
 
         synchronized (sources) {
             for (int i = sources.size() - 1; i >= 0; i--) {
             return;
         }
 
-        final List<String[]> changed = new ArrayList<String[]>();
+        final List<String[]> changed = new ArrayList<>();
 
         // Determine which settings will have changed
         for (String domain : identity.getDomains()) {
         }
     }
 
-    /**
-     * Returns the name of all domains known by this manager.
-     *
-     * @return A list of domains known to this manager
-     */
+    /** {@inheritDoc} */
+    @Override
     public Set<String> getDomains() {
-        final Set<String> res = new HashSet<String>();
+        final Set<String> res = new HashSet<>();
 
         synchronized (sources) {
             for (Identity source : sources) {
         return res;
     }
 
-    /**
-     * Retrieves a list of sources for this config manager.
-     * @return This config manager's sources.
-     */
+    /** {@inheritDoc} */
+    @Override
     public List<Identity> getSources() {
-        return new ArrayList<Identity>(sources);
+        return new ArrayList<>(sources);
     }
 
-    /**
-     * Migrates this ConfigManager from its current configuration to the
-     * appropriate one for the specified new parameters, firing listeners where
-     * settings have changed.
-     *
-     * @param protocol The protocol for this manager
-     * @param ircd The new name of the ircd for this manager
-     * @param network The new name of the network for this manager
-     * @param server The new name of the server for this manager
-     * @since 0.6.3
-     */
+    /** {@inheritDoc} */
+    @Override
     public void migrate(final String protocol, final String ircd,
             final String network, final String server) {
         migrate(protocol, ircd, network, server, "<Unknown>");
     }
 
-    /**
-     * Migrates this ConfigManager from its current configuration to the
-     * appropriate one for the specified new parameters, firing listeners where
-     * settings have changed.
-     *
-     * @param protocol The protocol for this manager
-     * @param ircd The new name of the ircd for this manager
-     * @param network The new name of the network for this manager
-     * @param server The new name of the server for this manager
-     * @param channel The new name of the channel for this manager
-     * @since 0.6.3
-     */
+    /** {@inheritDoc} */
+    @Override
     public void migrate(final String protocol, final String ircd,
             final String network, final String server, final String channel) {
         log.debug("Migrating from {{}, {}, {}, {}, {}} to {{}, {}, {}, {}, {}}",
         this.server = server;
         this.channel = channel + "@" + network;
 
-        for (Identity identity : new ArrayList<Identity>(sources)) {
+        for (Identity identity : new ArrayList<>(sources)) {
             if (!identityApplies(identity)) {
                 log.debug("Removing identity that no longer applies: {}", identity);
                 removeIdentity(identity);
         return STATS;
     }
 
-    /**
-     * Adds a change listener for the specified domain.
-     *
-     * @param domain The domain to be monitored
-     * @param listener The listener to register
-     */
+    /** {@inheritDoc} */
+    @Override
     public void addChangeListener(final String domain,
             final ConfigChangeListener listener) {
         addListener(domain, listener);
     }
 
-    /**
-     * Adds a change listener for the specified domain and key.
-     *
-     * @param domain The domain of the option
-     * @param key The option to be monitored
-     * @param listener The listener to register
-     */
+    /** {@inheritDoc} */
+    @Override
     public void addChangeListener(final String domain, final String key,
             final ConfigChangeListener listener) {
         addListener(domain + "." + key, listener);
     }
 
-    /**
-     * Removes the specified listener for all domains and options.
-     *
-     * @param listener The listener to be removed
-     */
+    /** {@inheritDoc} */
+    @Override
     public void removeListener(final ConfigChangeListener listener) {
         synchronized (listeners) {
             listeners.removeFromAll(listener);
     /** {@inheritDoc} */
     @Override
     public void configChanged(final String domain, final String key) {
-        final List<ConfigChangeListener> targets
-                = new ArrayList<ConfigChangeListener>();
+        final List<ConfigChangeListener> targets = new ArrayList<>();
 
         if (listeners.containsKey(domain)) {
             targets.addAll(listeners.get(domain));

src/com/dmdirc/config/ConfigSource.java

 
 package com.dmdirc.config;
 
+import com.dmdirc.interfaces.config.ReadOnlyConfigProvider;
 import com.dmdirc.ui.Colour;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.util.validators.ColourValidator;
  * an implementation that takes values from multiple sources, such as a
  * {@link ConfigManager}.
  */
-public abstract class ConfigSource {
+public abstract class ConfigSource implements ReadOnlyConfigProvider {
 
     /** A permissive validator to use when callers don't specify one. */
     private static final Validator<String> PERMISSIVE_VALIDATOR
         this(ColourManager.getColourManagerProvider());
     }
 
-    /**
-     * Retrieves the specified option from this config source.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @return The value of the option, or null if it doesn't exist
-     */
+    /** {@inheritDoc} */
+    @Override
     public String getOption(final String domain, final String option) {
         return getOption(domain, option, PERMISSIVE_VALIDATOR);
     }
 
-    /**
-     * Retrieves the first value for the specified option that matches the
-     * specified validator.
-     *
-     * @since 0.6.5
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param validator The validator to use to check legal values
-     * @return The value of the option, or null if no matching values exist
-     */
-    protected abstract String getOption(final String domain,
+    /** {@inheritDoc} */
+    @Override
+    public abstract String getOption(final String domain,
             final String option, final Validator<String> validator);
 
     /**
     protected abstract boolean hasOption(final String domain,
             final String option, final Validator<String> validator);
 
-    /**
-     * Determines if this source has the specified String option.
-     * <p>
-     * A String option is considered to exist if:
-     * <ul>
-     *  <li>there is a value for the specified option,
-     *  <li>that value is not empty, and
-     *  <li>that value is not disabled (i.e., it doesn't begin with "false:")
-     * </ul>
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @since 0.6.3m1
-     * @return True iff the option exists and is not empty, false otherwise
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionString(final String domain, final String option) {
         return hasOptionString(domain, option, PERMISSIVE_VALIDATOR);
     }
 
-    /**
-     * Determines if this source has the specified String option.
-     * <p>
-     * A String option is considered to exist if:
-     * <ul>
-     *  <li>there is a value for the specified option that
-     *      satisfies the specified validator,
-     *  <li>that value is not empty, and
-     *  <li>that value is not disabled (i.e., it doesn't begin with "false:")
-     * </ul>
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param validator The validator to use to check legal values
-     * @since 0.6.5
-     * @return True iff the option exists and is not empty, false otherwise
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionString(final String domain, final String option,
             final Validator<String> validator) {
         String value;
                 && !value.startsWith("false:");
     }
 
-    /**
-     * Determines if this source has the specified integer option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @since 0.6.3m1
-     * @return True iff the option exists and is parsable as an integer,
-     * false otherwise.
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionInt(final String domain, final String option) {
         return hasOptionString(domain, option, INT_VALIDATOR);
     }
 
-    /**
-     * Determines if this source has the specified character option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @since 0.6.3m1
-     * @return True iff the option exists and is parsable as a char,
-     * false otherwise.
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionChar(final String domain, final String option) {
         return hasOptionString(domain, option);
     }
 
-    /**
-     * Determines if this source has the specified colour option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @since 0.6.3m1
-     * @return True iff the option exists and is parsable as a colour,
-     * false otherwise.
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionColour(final String domain, final String option) {
         return hasOptionString(domain, option, COLOUR_VALIDATOR);
     }
 
-    /**
-     * Retrieves a boolean representation of the specified option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @return The boolean representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean hasOptionBool(final String domain, final String option) {
         return hasOption(domain, option, PERMISSIVE_VALIDATOR);
     }
 
-    /**
-     * Retrieves the specified option as a String, if it exists and satisfies
-     * the specified validator.
-     * <p>
-     * If no fallback settings are supplied (or if fallback settings are
-     * supplied and execution reaches the last fallback setting) AND if the
-     * 'required' parameter is true, then all disabled values (i.e., those
-     * starting with <code>false:</code>) will be ignored. To check if a valid
-     * non-disabled value exists, call
-     * {@link #hasOptionString(java.lang.String, java.lang.String, com.dmdirc.util.validators.Validator)}.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param required Whether the specified option is required or not
-     * @param validator The validator to use to check the value
-     * @param fallbacks An ordered array of further domains and options
-     * (in pairs) to try if the specified domain/option isn't found
-     * @return The string representation of the option or null if optional
-     * setting is not specified
-     * @since 0.6.5
-     */
+    /** {@inheritDoc} */
+    @Override
     public String getOptionString(final String domain, final String option,
             final boolean required, final Validator<String> validator,
             final String ... fallbacks) {
         }
     }
 
-    /**
-     * Retrieves the specified option as a String, if it exists.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param fallbacks An ordered array of further domains and options
-     * (in pairs) to try if the specified domain/option isn't found
-     * @return The string representation of the option or null if optional
-     * setting is not specified
-     * @since 0.6.3
-     */
+    /** {@inheritDoc} */
+    @Override
     public String getOptionString(final String domain, final String option,
             final String ... fallbacks) {
         return getOptionString(domain, option, true, PERMISSIVE_VALIDATOR, fallbacks);
     }
 
-    /**
-     * Retrieves the specified option as a character.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @return The value of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public char getOptionChar(final String domain, final String option) {
         return getOption(domain, option).charAt(0);
     }
 
-    /**
-     * Retrieves a colour representation of the specified option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param fallbacks An ordered array of further domains and options
-     * (in pairs) to try if the specified domain/option isn't found
-     * @return The colour representation of the option
-     * @since 0.6.3m1
-     */
+    /** {@inheritDoc} */
+    @Override
     public Colour getOptionColour(final String domain, final String option,
             final String ... fallbacks) {
         final String value = getOptionString(domain, option, true, COLOUR_VALIDATOR, fallbacks);
         return value == null ? null : colourManager.get().getColourFromString(value, null);
     }
 
-    /**
-     * Retrieves a boolean representation of the specified option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @return The boolean representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean getOptionBool(final String domain, final String option) {
         return Boolean.parseBoolean(getOption(domain, option));
     }
 
-    /**
-     * Retrieves a list representation of the specified option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param trimEmpty Whether or not to trim empty lines
-     * @return The list representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public List<String> getOptionList(final String domain, final String option,
             final boolean trimEmpty) {
         final List<String> res = new ArrayList<>();
         return res;
     }
 
-    /**
-     * Retrieves a list representation of the specified option, trimming empty
-     * lines by default.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @return The list representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public List<String> getOptionList(final String domain, final String option) {
         return getOptionList(domain, option, true);
     }
 
-    /**
-     * Retrieves an integral representation of the specified option.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param fallbacks An ordered array of further domains and options
-     * (in pairs) to try if the specified domain/option isn't found
-     * @return The integer representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public Integer getOptionInt(final String domain, final String option,
             final String ... fallbacks) {
         return getOptionInt(domain, option, true, fallbacks);
     }
 
-    /**
-     * Retrieves an integral representation of the specified option.
-     *
-     * @since 0.6.5
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param required Whether this option is required or optional
-     * @param fallbacks An ordered array of further domains and options
-     * (in pairs) to try if the specified domain/option isn't found
-     * @return The integer representation of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public Integer getOptionInt(final String domain, final String option,
             final boolean required, final String ... fallbacks) {
         final String value = getOptionString(domain, option, required, INT_VALIDATOR, fallbacks);

src/com/dmdirc/config/Identity.java

 package com.dmdirc.config;
 
 import com.dmdirc.interfaces.ConfigChangeListener;
+import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.util.collections.WeakList;
  * Note: this class has a natural ordering that is inconsistent with equals.
  */
 @Slf4j
-public class Identity extends ConfigSource implements Comparable<Identity> {
+public class Identity extends ConfigSource implements Comparable<Identity>, ConfigProvider {
 
     /** A regular expression that will match all characters illegal in file names. */
     protected static final String ILLEGAL_CHARS = "[\\\\\"/:\\*\\?\"<>\\|]";
     protected ConfigManager globalConfig;
 
     /** The config change listeners for this source. */
-    protected final List<ConfigChangeListener> listeners
-            = new WeakList<ConfigChangeListener>();
+    protected final List<ConfigChangeListener> listeners = new WeakList<>();
 
     /** Whether this identity needs to be saved. */
     protected boolean needSave;
      *
      * @since 0.6.3
      * @param forceDefault Whether to force this to be a default identity
-     * @param file The file to load this identity from (or null)
      * @throws InvalidIdentityFileException if the identity file is invalid
      * @throws IOException On I/O exception when reading the identity
      */
         }
     }
 
-    /**
-     * Attempts to reload this identity from disk. If this identity has been
-     * modified (i.e., {@code needSave} is true), then this method silently
-     * returns straight away. All relevant ConfigChangeListeners are fired for
-     * new, altered and deleted properties. The target of the identity will not
-     * be changed by this method, even if it has changed on disk.
-     *
-     * @throws java.io.IOException On I/O exception when reading the identity
-     * @throws InvalidConfigFileException if the config file is no longer valid
-     */
+    /** {@inheritDoc} */
+    @Override
     public void reload() throws IOException, InvalidConfigFileException {
         if (needSave) {
             return;
         }
 
-        final List<String[]> changes = new LinkedList<String[]>();
+        final List<String[]> changes = new LinkedList<>();
 
         synchronized (this) {
             final Map<String, Map<String, String>> oldProps = file.getKeyDomains();
      * @since 0.6.3m1
      */
     private void fireSettingChange(final String domain, final String key) {
-        for (ConfigChangeListener listener : new ArrayList<ConfigChangeListener>(listeners)) {
+        for (ConfigChangeListener listener : new ArrayList<>(listeners)) {
             listener.configChanged(domain, key);
         }
     }
 
-    /**
-     * Returns the name of this identity.
-     *
-     * @return The name of this identity
-     */
+    /** {@inheritDoc} */
+    @Override
     public String getName() {
         if (hasOptionString(DOMAIN, "name")) {
             return getOption(DOMAIN, "name");
         }
     }
 
-    /**
-     * Determines whether this identity can be used as a profile when
-     * connecting to a server. Profiles are identities that can supply
-     * nick, ident, real name, etc.
-     *
-     * @return True iff this identity can be used as a profile
-     */
+    /** {@inheritDoc} */
+    @Override
     public boolean isProfile() {
         return (hasOptionString(PROFILE_DOMAIN, "nicknames")
                 || hasOptionString(PROFILE_DOMAIN, "nickname"))
         return value;
     }
 
-    /**
-     * Sets the specified option in this identity to the specified value.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param value The new value for the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public void setOption(final String domain, final String option,
             final String value) {
         String oldValue;
         }
     }
 
-    /**
-     * Sets the specified option in this identity to the specified value.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param value The new value for the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public void setOption(final String domain, final String option,
             final int value) {
         setOption(domain, option, String.valueOf(value));
     }
 
-    /**
-     * Sets the specified option in this identity to the specified value.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param value The new value for the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public void setOption(final String domain, final String option,
             final boolean value) {
         setOption(domain, option, String.valueOf(value));
     }
 
-    /**
-     * Sets the specified option in this identity to the specified value.
-     *
-     * @param domain The domain of the option
-     * @param option The name of the option
-     * @param value The new value for the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public void setOption(final String domain, final String option,
             final List<String> value) {
         final StringBuilder temp = new StringBuilder();
         setOption(domain, option, temp.length() > 0 ? temp.substring(1) : temp.toString());
     }
 
-    /**
-     * Unsets a specified option.
-     *
-     * @param domain domain of the option
-     * @param option name of the option
-     */
+    /** {@inheritDoc} */
+    @Override
     public void unsetOption(final String domain, final String option) {
         synchronized (this) {
             file.getKeyDomain(domain).remove(option);
         fireSettingChange(domain, option);
     }
 
-    /**
-     * Returns the set of domains available in this identity.
-     *
-     * @since 0.6
-     * @return The set of domains used by this identity
-     */
+    /** {@inheritDoc} */
+    @Override
     public Set<String> getDomains() {
-        return new HashSet<String>(file.getKeyDomains().keySet());
+        return new HashSet<>(file.getKeyDomains().keySet());
     }
 
-    /**
-     * Retrieves a map of all options within the specified domain in this
-     * identity.
-     *
-     * @param domain The domain to retrieve
-     * @since 0.6
-     * @return A map of option names to values
-     */
+    /** {@inheritDoc} */
+    @Override
     public synchronized Map<String, String> getOptions(final String domain) {
-        return new HashMap<String, String>(file.getKeyDomain(domain));
+        return new HashMap<>(file.getKeyDomain(domain));
     }
 
-    /**
-     * Saves this identity to disk if it has been updated.
-     */
+    /** {@inheritDoc} */
+    @Override
     public synchronized void save() {
         log.info("{}: saving. Needsave = {}", new Object[]{ getName(), needSave });
 
                         : file.getKeyDomains().entrySet()) {
                     final String domain = entry.getKey();
 
-                    for (Map.Entry<String, String> subentry
-                        : new HashSet<Map.Entry<String, String>>(entry.getValue().entrySet())) {
+                    for (Map.Entry<String, String> subentry : new HashSet<>(entry.getValue().entrySet())) {
                         final String key = subentry.getKey();
                         final String value = subentry.getValue();
 
         }
     }
 
-    /**
-     * Deletes this identity from disk.
-     */
+    /** {@inheritDoc} */
+    @Override
     public synchronized void delete() {
         if (file != null) {
             file.delete();
         IdentityManager.getIdentityManager().unregisterIdentity(this);
     }
 
-    /**
-     * Retrieves this identity's target.
-     *
-     * @return The target of this identity
-     */
+    /** {@inheritDoc} */
+    @Override
     public ConfigTarget getTarget() {
         return myTarget;
     }
         return file != null && file.getFile() != null && file.getFile().equals(target);
     }
 
-    /**
-     * Adds a new config change listener for this identity.
-     *
-     * @param listener The listener to be added
-     */
+    /** {@inheritDoc} */
+    @Override
     public void addListener(final ConfigChangeListener listener) {
         listeners.add(listener);
     }
 
-    /**
-     * Removes the specific config change listener from this identity.
-     *
-     * @param listener The listener to be removed
-     */
+    /** {@inheritDoc} */
+    @Override
     public void removeListener(final ConfigChangeListener listener) {
         listeners.remove(listener);
     }
      */
     public static Identity buildIdentity(final ConfigTarget target)
             throws IOException {
-        final Map<String, Map<String, String>> settings
-                = new HashMap<String, Map<String, String>>();
+        final Map<String, Map<String, String>> settings = new HashMap<>();
         settings.put(DOMAIN, new HashMap<String, String>(2));
         settings.get(DOMAIN).put("name", target.getData());
         settings.get(DOMAIN).put(target.getTypeName(), target.getData());
      * @see #createIdentity(java.util.Map)
      */
     public static Identity buildProfile(final String name) throws IOException {
-        final Map<String, Map<String, String>> settings
-                = new HashMap<String, Map<String, String>>();
+        final Map<String, Map<String, String>> settings = new HashMap<>();
         settings.put(DOMAIN, new HashMap<String, String>(1));
         settings.put(PROFILE_DOMAIN, new HashMap<String, String>(2));
 
      */
     public static Identity buildIdentity(final String name, final String type)
             throws IOException {
-        final Map<String, Map<String, String>> settings
-                = new HashMap<String, Map<String, String>>();
+        final Map<String, Map<String, String>> settings = new HashMap<>();
         settings.put(DOMAIN, new HashMap<String, String>(2));
 
         settings.get(DOMAIN).put("name", name);

src/com/dmdirc/interfaces/config/AggregateConfigProvider.java

+/*
+ * Copyright (c) 2006-2013 DMDirc Developers
+ *
+ * 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 com.dmdirc.interfaces.config;
+
+import com.dmdirc.config.Identity;
+import com.dmdirc.interfaces.ConfigChangeListener;
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * A configuration provider which aggregates an ordered list of other
+ * {@link ConfigProvider}s.
+ *
+ * Because this provider exposes settings from multiple independent sources,
+ * it cannot change any settings as the scope of such changes may be unclear.
+ */
+public interface AggregateConfigProvider extends ReadOnlyConfigProvider {
+
+    /**
+     * Adds a change listener for the specified domain.
+     *
+     * @param domain The domain to be monitored
+     * @param listener The listener to register
+     */
+    void addChangeListener(String domain, ConfigChangeListener listener);
+
+    /**
+     * Adds a change listener for the specified domain and key.
+     *
+     * @param domain The domain of the option
+     * @param key The option to be monitored
+     * @param listener The listener to register
+     */
+    void addChangeListener(String domain, String key, ConfigChangeListener listener);
+
+    /**
+     * Returns the name of all domains known by this manager.
+     *
+     * @return A list of domains known to this manager
+     */
+    Set<String> getDomains();
+
+    /**
+     * Retrieves a list of sources for this config manager.
+     * @return This config manager's sources.
+     */
+    List<Identity> getSources();
+
+    /**
+     * Removes the specified listener for all domains and options.
+     *
+     * @param listener The listener to be removed
+     */
+    void removeListener(ConfigChangeListener listener);
+
+    /**
+     * Migrates this ConfigManager from its current configuration to the
+     * appropriate one for the specified new parameters, firing listeners where
+     * settings have changed.
+     *
+     * @param protocol The protocol for this manager
+     * @param ircd The new name of the ircd for this manager
+     * @param network The new name of the network for this manager
+     * @param server The new name of the server for this manager
+     * @since 0.6.3
+     */
+    void migrate(String protocol, String ircd, String network, String server);
+
+    /**
+     * Migrates this ConfigManager from its current configuration to the
+     * appropriate one for the specified new parameters, firing listeners where
+     * settings have changed.
+     *
+     * @param protocol The protocol for this manager
+     * @param ircd The new name of the ircd for this manager
+     * @param network The new name of the network for this manager
+     * @param server The new name of the server for this manager
+     * @param channel The new name of the channel for this manager
+     * @since 0.6.3
+     */
+    void migrate(String protocol, String ircd, String network, String server, String channel);
+
+}

src/com/dmdirc/interfaces/config/ConfigProvider.java

+/*
+ * Copyright (c) 2006-2013 DMDirc Developers
+ *
+ * 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 com.dmdirc.interfaces.config;
+
+import com.dmdirc.config.ConfigTarget;
+import com.dmdirc.interfaces.ConfigChangeListener;
+import com.dmdirc.util.io.InvalidConfigFileException;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Provides methods to read and write from a single configuration source, such
+ * as a file on disk.
+ */
+public interface ConfigProvider extends ReadOnlyConfigProvider {
+
+    /**
+     * Adds a new config change listener for this identity.
+     *
+     * @param listener The listener to be added
+     */
+    void addListener(ConfigChangeListener listener);
+
+    /**
+     * Deletes this identity from disk.
+     */
+    void delete();
+
+    /**
+     * Returns the set of domains available in this identity.
+     *
+     * @since 0.6
+     * @return The set of domains used by this identity
+     */
+    Set<String> getDomains();
+
+    /**
+     * Returns the name of this identity.
+     *
+     * @return The name of this identity
+     */
+    String getName();
+
+    /**
+     * Retrieves this identity's target.
+     *
+     * @return The target of this identity
+     */
+    ConfigTarget getTarget();
+
+    /**
+     * Determines whether this identity can be used as a profile when
+     * connecting to a server. Profiles are identities that can supply
+     * nick, ident, real name, etc.
+     *
+     * @return True iff this identity can be used as a profile
+     */
+    boolean isProfile();
+
+    /**
+     * Attempts to reload this identity from disk. If this identity has been
+     * modified (i.e., {@code needSave} is true), then this method silently
+     * returns straight away. All relevant ConfigChangeListeners are fired for
+     * new, altered and deleted properties. The target of the identity will not
+     * be changed by this method, even if it has changed on disk.
+     *
+     * @throws java.io.IOException On I/O exception when reading the identity
+     * @throws InvalidConfigFileException if the config file is no longer valid
+     */
+    void reload() throws IOException, InvalidConfigFileException;
+
+    /**
+     * Removes the specific config change listener from this identity.
+     *
+     * @param listener The listener to be removed
+     */
+    void removeListener(ConfigChangeListener listener);
+
+    /**
+     * Saves this identity to disk if it has been updated.
+     */
+    void save();
+
+    /**
+     * Sets the specified option in this identity to the specified value.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param value The new value for the option
+     */
+    void setOption(String domain, String option, String value);
+
+    /**
+     * Sets the specified option in this identity to the specified value.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param value The new value for the option
+     */
+    void setOption(String domain, String option, int value);
+
+    /**
+     * Sets the specified option in this identity to the specified value.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param value The new value for the option
+     */
+    void setOption(String domain, String option, boolean value);
+
+    /**
+     * Sets the specified option in this identity to the specified value.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param value The new value for the option
+     */
+    void setOption(String domain, String option, List<String> value);
+
+    /**
+     * Unsets a specified option.
+     *
+     * @param domain domain of the option
+     * @param option name of the option
+     */
+    void unsetOption(String domain, String option);
+
+}

src/com/dmdirc/interfaces/config/ReadOnlyConfigProvider.java

+/*
+ * Copyright (c) 2006-2013 DMDirc Developers
+ *
+ * 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 com.dmdirc.interfaces.config;
+
+import com.dmdirc.ui.Colour;
+import com.dmdirc.util.validators.Validator;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A source of configuration settings that can only be read from.
+ */
+public interface ReadOnlyConfigProvider {
+
+    /**
+     * Retrieves the specified option from this config source.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @return The value of the option, or null if it doesn't exist
+     */
+    String getOption(String domain, String option);
+
+    /**
+     * Retrieves the first value for the specified option that matches the
+     * specified validator.
+     *
+     * @since 0.6.5
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param validator The validator to use to check legal values
+     * @return The value of the option, or null if no matching values exist
+     */
+    String getOption(String domain, String option, Validator<String> validator);
+
+    /**
+     * Retrieves a boolean representation of the specified option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @return The boolean representation of the option
+     */
+    boolean getOptionBool(String domain, String option);
+
+    /**
+     * Retrieves the specified option as a character.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @return The value of the option
+     */
+    char getOptionChar(String domain, String option);
+
+    /**
+     * Retrieves a colour representation of the specified option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param fallbacks An ordered array of further domains and options
+     * (in pairs) to try if the specified domain/option isn't found
+     * @return The colour representation of the option
+     * @since 0.6.3m1
+     */
+    Colour getOptionColour(String domain, String option, String... fallbacks);
+
+    /**
+     * Retrieves an integral representation of the specified option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param fallbacks An ordered array of further domains and options
+     * (in pairs) to try if the specified domain/option isn't found
+     * @return The integer representation of the option
+     */
+    Integer getOptionInt(String domain, String option, String... fallbacks);
+
+    /**
+     * Retrieves an integral representation of the specified option.
+     *
+     * @since 0.6.5
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param required Whether this option is required or optional
+     * @param fallbacks An ordered array of further domains and options
+     * (in pairs) to try if the specified domain/option isn't found
+     * @return The integer representation of the option
+     */
+    Integer getOptionInt(String domain, String option, boolean required, String... fallbacks);
+
+    /**
+     * Retrieves a list representation of the specified option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param trimEmpty Whether or not to trim empty lines
+     * @return The list representation of the option
+     */
+    List<String> getOptionList(String domain, String option, boolean trimEmpty);
+
+    /**
+     * Retrieves a list representation of the specified option, trimming empty
+     * lines by default.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @return The list representation of the option
+     */
+    List<String> getOptionList(String domain, String option);
+
+    /**
+     * Retrieves the specified option as a String, if it exists and satisfies
+     * the specified validator.
+     * <p>
+     * If no fallback settings are supplied (or if fallback settings are
+     * supplied and execution reaches the last fallback setting) AND if the
+     * 'required' parameter is true, then all disabled values (i.e., those
+     * starting with <code>false:</code>) will be ignored. To check if a valid
+     * non-disabled value exists, call
+     * {@link #hasOptionString(java.lang.String, java.lang.String, com.dmdirc.util.validators.Validator)}.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param required Whether the specified option is required or not
+     * @param validator The validator to use to check the value
+     * @param fallbacks An ordered array of further domains and options
+     * (in pairs) to try if the specified domain/option isn't found
+     * @return The string representation of the option or null if optional
+     * setting is not specified
+     * @since 0.6.5
+     */
+    String getOptionString(String domain, String option, boolean required, Validator<String> validator, String... fallbacks);
+
+    /**
+     * Retrieves the specified option as a String, if it exists.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param fallbacks An ordered array of further domains and options
+     * (in pairs) to try if the specified domain/option isn't found
+     * @return The string representation of the option or null if optional
+     * setting is not specified
+     * @since 0.6.3
+     */
+    String getOptionString(String domain, String option, String... fallbacks);
+
+    /**
+     * Retrieves a boolean representation of the specified option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @return The boolean representation of the option
+     */
+    boolean hasOptionBool(String domain, String option);
+
+    /**
+     * Determines if this source has the specified character option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @since 0.6.3m1
+     * @return True iff the option exists and is parsable as a char,
+     * false otherwise.
+     */
+    boolean hasOptionChar(String domain, String option);
+
+    /**
+     * Determines if this source has the specified colour option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @since 0.6.3m1
+     * @return True iff the option exists and is parsable as a colour,
+     * false otherwise.
+     */
+    boolean hasOptionColour(String domain, String option);
+
+    /**
+     * Determines if this source has the specified integer option.
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @since 0.6.3m1
+     * @return True iff the option exists and is parsable as an integer,
+     * false otherwise.
+     */
+    boolean hasOptionInt(String domain, String option);
+
+    /**
+     * Determines if this source has the specified String option.
+     * <p>
+     * A String option is considered to exist if:
+     * <ul>
+     *  <li>there is a value for the specified option,
+     *  <li>that value is not empty, and
+     *  <li>that value is not disabled (i.e., it doesn't begin with "false:")
+     * </ul>
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @since 0.6.3m1
+     * @return True iff the option exists and is not empty, false otherwise
+     */
+    boolean hasOptionString(String domain, String option);
+
+    /**
+     * Determines if this source has the specified String option.
+     * <p>
+     * A String option is considered to exist if:
+     * <ul>
+     *  <li>there is a value for the specified option that
+     *      satisfies the specified validator,
+     *  <li>that value is not empty, and
+     *  <li>that value is not disabled (i.e., it doesn't begin with "false:")
+     * </ul>
+     *
+     * @param domain The domain of the option
+     * @param option The name of the option
+     * @param validator The validator to use to check legal values
+     * @since 0.6.5
+     * @return True iff the option exists and is not empty, false otherwise
+     */
+    boolean hasOptionString(String domain, String option, Validator<String> validator);
+
+    /**
+     * Returns the name of all the options in the specified domain. If the
+     * domain doesn't exist, an empty list is returned.
+     *
+     * @param domain The domain to search
+     * @return A list of options in the specified domain
+     */
+    Map<String, String> getOptions(String domain);
+
+}

test/com/dmdirc/harness/TestConfigSource.java

 
 package com.dmdirc.harness;
 
-import com.dmdirc.config.*;
+import com.dmdirc.config.ConfigSource;
 import com.dmdirc.util.validators.Validator;
 
+import java.util.Map;
+
 public class TestConfigSource extends ConfigSource {
 
     @Override
     }
 
     @Override
-    protected String getOption(String domain, String option, Validator<String> validator) {
+    public String getOption(String domain, String option, Validator<String> validator) {
         return option;
     }
+
+    @Override
+    public Map<String, String> getOptions(String domain) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
 }