Merge pull request #732 from csmith/master

Add an interface for tab completers, move to API.

api/src/main/java/com/dmdirc/ui/input/TabCompleter.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2006-2015 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.ui.input;
+
+import javax.annotation.Nullable;
+import java.util.List;
+
+/**
+ * The tab completer handles a user's request to tab complete some word.
+ */
+public interface TabCompleter {
+
+    /**
+     * Attempts to complete the partial string.
+     *
+     * @param partial     The string to tab complete
+     * @param additionals A list of additional strings to use
+     *
+     * @return A TabCompleterResult containing any matches found
+     */
+    List<String> complete(String partial, @Nullable AdditionalTabTargets additionals);
+
+    /**
+     * Adds a new entry to this tab completer's list.
+     *
+     * @param type  The type of the entry that's being added
+     * @param entry The new entry to be added
+     */
+    void addEntry(TabCompletionType type, String entry);
+
+    /**
+     * Adds multiple new entries to this tab completer's list.
+     *
+     * @param type       The type of the entries that're being added
+     * @param newEntries Entries to be added
+     */
+    void addEntries(TabCompletionType type, Iterable<String> newEntries);
+
+    /**
+     * Removes a specified entry from this tab completer's list.
+     *
+     * @param type  The type of the entry that should be removed
+     * @param entry The entry to be removed
+     */
+    void removeEntry(TabCompletionType type, String entry);
+
+    /**
+     * Clears all entries in this tab completer.
+     */
+    void clear();
+
+    /**
+     * Clears all entries of the specified type in this tab completer.
+     *
+     * @param type The type of entry to clear
+     */
+    void clear(TabCompletionType type);
+
+}

src/main/java/com/dmdirc/ui/input/TabCompleterFactory.java

@@ -62,7 +62,7 @@ public class TabCompleterFactory {
     public TabCompleter getTabCompleter(
             final AggregateConfigProvider configProvider,
             final CommandType... commandTypes) {
-        final TabCompleter tabCompleter = new TabCompleter(configProvider);
+        final TabCompleter tabCompleter = new TabCompleterImpl(configProvider);
         addCommands(tabCompleter, commandTypes);
         return tabCompleter;
     }
@@ -81,7 +81,7 @@ public class TabCompleterFactory {
             final TabCompleter parent,
             final AggregateConfigProvider configProvider,
             final CommandType... commandTypes) {
-        final TabCompleter tabCompleter = new TabCompleter(configProvider, parent);
+        final TabCompleter tabCompleter = new TabCompleterImpl(configProvider, parent);
         addCommands(tabCompleter, commandTypes);
         return tabCompleter;
     }

src/main/java/com/dmdirc/ui/input/TabCompleter.java → src/main/java/com/dmdirc/ui/input/TabCompleterImpl.java

@@ -33,7 +33,7 @@ import java.util.List;
 /**
  * The tab completer handles a user's request to tab complete some word.
  */
-public class TabCompleter {
+public class TabCompleterImpl implements TabCompleter {
 
     /**
      * The parent TabCompleter. Results from parents are merged with results from this completer.
@@ -46,36 +46,29 @@ public class TabCompleter {
     private final Multimap<TabCompletionType, String> entries = ArrayListMultimap.create();
 
     /**
-     * Creates a new instance of {@link TabCompleter}.
+     * Creates a new instance of {@link TabCompleterImpl}.
      *
      * @param configManager     The manager to read config settings from.
      */
-    public TabCompleter(final AggregateConfigProvider configManager) {
+    public TabCompleterImpl(final AggregateConfigProvider configManager) {
         this.parent = null;
         this.configManager = configManager;
     }
 
     /**
-     * Creates a new instance of {@link TabCompleter}.
+     * Creates a new instance of {@link TabCompleterImpl}.
      *
      * @param configManager     The manager to read config settings from.
      * @param parent            The parent tab completer to inherit completions from.
      */
-    public TabCompleter(
+    public TabCompleterImpl(
             final AggregateConfigProvider configManager,
             @Nullable final TabCompleter parent) {
         this.parent = parent;
         this.configManager = configManager;
     }
 
-    /**
-     * Attempts to complete the partial string.
-     *
-     * @param partial     The string to tab complete
-     * @param additionals A list of additional strings to use
-     *
-     * @return A TabCompleterResult containing any matches found
-     */
+    @Override
     public List<String> complete(final String partial, @Nullable final AdditionalTabTargets additionals) {
         final List<String> result = new ArrayList<>();
 
@@ -118,22 +111,12 @@ public class TabCompleter {
         return result;
     }
 
-    /**
-     * Adds a new entry to this tab completer's list.
-     *
-     * @param type  The type of the entry that's being added
-     * @param entry The new entry to be added
-     */
+    @Override
     public void addEntry(final TabCompletionType type, final String entry) {
         entries.put(type, entry);
     }
 
-    /**
-     * Adds multiple new entries to this tab completer's list.
-     *
-     * @param type       The type of the entries that're being added
-     * @param newEntries Entries to be added
-     */
+    @Override
     public void addEntries(final TabCompletionType type, final Iterable<String> newEntries) {
         if (newEntries == null) {
             return;
@@ -144,28 +127,17 @@ public class TabCompleter {
         }
     }
 
-    /**
-     * Removes a specified entry from this tab completer's list.
-     *
-     * @param type  The type of the entry that should be removed
-     * @param entry The entry to be removed
-     */
+    @Override
     public void removeEntry(final TabCompletionType type, final String entry) {
         entries.remove(type, entry);
     }
 
-    /**
-     * Clears all entries in this tab completer.
-     */
+    @Override
     public void clear() {
         entries.clear();
     }
 
-    /**
-     * Clears all entries of the specified type in this tab completer.
-     *
-     * @param type The type of entry to clear
-     */
+    @Override
     public void clear(final TabCompletionType type) {
         entries.removeAll(type);
     }

src/test/java/com/dmdirc/harness/TestWritableFrameContainer.java

@@ -29,7 +29,7 @@ import com.dmdirc.commandparser.parsers.GlobalCommandParser;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.EventBus;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
-import com.dmdirc.ui.input.TabCompleter;
+import com.dmdirc.ui.input.TabCompleterImpl;
 import com.dmdirc.ui.messages.BackBufferFactory;
 
 import java.util.Collections;
@@ -49,7 +49,7 @@ public class TestWritableFrameContainer extends FrameContainer {
                 new DefaultInputModel(
                         line -> {},
                         new GlobalCommandParser(cm, commandManager, eventBus),
-                        new TabCompleter(cm),
+                        new TabCompleterImpl(cm),
                         () -> lineLength));
     }