Tidy up some common parser files.

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

src/com/dmdirc/parser/common/AwayState.java

@@ -24,9 +24,6 @@ package com.dmdirc.parser.common;
 
 /**
  * Away states.
- *
- * @author Shane
- * @since 0.6.3
  */
 public enum AwayState {
 
@@ -42,7 +39,7 @@ public enum AwayState {
 
     /**
      * Adds a friendly name to the away state.
-     * <p/>
+     *
      * @param friendlyName Friendly name
      */
     AwayState(final String friendlyName) {

src/com/dmdirc/parser/common/BaseChannelClientInfo.java

@@ -66,13 +66,14 @@ public abstract class BaseChannelClientInfo implements ChannelClientInfo {
     }
 
     @Override
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     public Map<Object, Object> getMap() {
         return map;
     }
 
     @Override
     public String toString() {
-        return getImportantMode() + client.toString();
+        return getImportantMode() + client;
     }
 
 }

src/com/dmdirc/parser/common/BaseChannelInfo.java

@@ -53,6 +53,7 @@ public abstract class BaseChannelInfo implements ChannelInfo {
     }
 
     @Override
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     public Map<Object, Object> getMap() {
         return map;
     }

src/com/dmdirc/parser/common/BaseClientInfo.java

@@ -40,7 +40,11 @@ public abstract class BaseClientInfo implements ClientInfo {
     private final Map<Object, Object> map = new HashMap<>();
 
     /** The user's details. */
-    private String nick, user, host, realname, account = null;
+    private String nick;
+    private String user;
+    private String host;
+    private String realname;
+    private String account;
 
     /**
      * Creates a new base client info for the specified parser with the
@@ -130,6 +134,7 @@ public abstract class BaseClientInfo implements ClientInfo {
     }
 
     @Override
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     public Map<Object, Object> getMap() {
         return map;
     }

src/com/dmdirc/parser/common/BaseParser.java

@@ -22,6 +22,8 @@
 
 package com.dmdirc.parser.common;
 
+import com.dmdirc.parser.interfaces.ChannelInfo;
+import com.dmdirc.parser.interfaces.ClientInfo;
 import com.dmdirc.parser.interfaces.callbacks.CallbackInterface;
 
 import java.net.InetSocketAddress;
@@ -35,11 +37,10 @@ import java.util.List;
 import java.util.Map;
 
 /**
- * Implements common base functionality for parsers.<p>
- * Implementations of this class must be annotated with
- * {@link ChildImplementations} to define the implementations to use for
- * instances of {@link com.dmdirc.parser.interfaces.ClientInfo},
- * {@link com.dmdirc.parser.interfaces.ChannelInfo}, etc.
+ * Implements common base functionality for parsers.
+ * <p>
+ * Implementations of this class must be annotated with {@link ChildImplementations} to define
+ * the implementations to use for instances of {@link ClientInfo}, {@link ChannelInfo}, etc.
  */
 public abstract class BaseParser extends ThreadedParser {
 
@@ -83,7 +84,7 @@ public abstract class BaseParser extends ThreadedParser {
 
         final Map<Class<?>, Class<?>> implementations = new HashMap<>();
 
-        for (Class<?> child : this.getClass().getAnnotation(ChildImplementations.class).value()) {
+        for (Class<?> child : getClass().getAnnotation(ChildImplementations.class).value()) {
             for (Class<?> iface : child.getInterfaces()) {
                 implementations.put(iface, child);
             }
@@ -177,6 +178,7 @@ public abstract class BaseParser extends ThreadedParser {
     }
 
     @Override
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     public Map<Object, Object> getMap() {
         return map;
     }

src/com/dmdirc/parser/common/CallbackNotFoundException.java

@@ -24,8 +24,6 @@ package com.dmdirc.parser.common;
 
 /**
  * IRC Parser Callback Exception.
- *
- * @author Shane Mc Cormack
  */
 public class CallbackNotFoundException extends RuntimeException {
     /**

src/com/dmdirc/parser/common/ChannelJoinRequest.java

@@ -24,9 +24,6 @@ package com.dmdirc.parser.common;
 
 /**
  * Describes the information needed to try and join a channel.
- *
- * @author chris
- * @since 0.6.4
  */
 public class ChannelJoinRequest {
 

src/com/dmdirc/parser/common/ChannelListModeItem.java

@@ -22,12 +22,12 @@
 
 package com.dmdirc.parser.common;
 
+import com.dmdirc.parser.interfaces.Parser;
+
 /**
  * Contains Channel List Mode information.
  *
- * @author Shane Mc Cormack
- * @author Chris Smith
- * @see com.dmdirc.parser.interfaces.Parser
+ * @see Parser
  */
 public class ChannelListModeItem {
 

src/com/dmdirc/parser/common/CompositionState.java

@@ -24,8 +24,6 @@ package com.dmdirc.parser.common;
 
 /**
  * Possible composition states for remote users.
- *
- * @since 0.6.6
  */
 public enum CompositionState {
 

src/com/dmdirc/parser/common/DefaultStringConverter.java

@@ -26,9 +26,6 @@ import com.dmdirc.parser.interfaces.StringConverter;
 
 /**
  * A {@link StringConverter} that uses the system's default charset.
- *
- * @since 0.6.3m2
- * @author chris
  */
 public class DefaultStringConverter implements StringConverter {
 

src/com/dmdirc/parser/common/IgnoreList.java

@@ -46,7 +46,7 @@ public class IgnoreList {
      *
      * @param items Items to add to this RegexStringList
      */
-    public IgnoreList(final List<String> items) {
+    public IgnoreList(final Iterable<String> items) {
         addAll(items);
     }
 
@@ -70,7 +70,7 @@ public class IgnoreList {
      *
      * @param patterns A list of patterns to be added
      */
-    public void addAll(final List<String> patterns) {
+    public void addAll(final Iterable<String> patterns) {
         for (String pattern : patterns) {
             add(pattern);
         }
@@ -82,7 +82,7 @@ public class IgnoreList {
      * @param position Position in the list to remove
      */
     public void remove(final int position) {
-        if (position < this.count()) {
+        if (position < count()) {
             ignoreInfo.remove(position);
         }
     }
@@ -102,8 +102,8 @@ public class IgnoreList {
      * @throws PatternSyntaxException if one of the items in the list is an invalid regex
      */
     public int matches(final String check) throws PatternSyntaxException {
-        for (int i = 0; i < this.count(); ++i) {
-            if (check.matches("(?i)" + this.get(i))) {
+        for (int i = 0; i < count(); i++) {
+            if (check.matches("(?i)" + get(i))) {
                 return i;
             }
         }
@@ -120,11 +120,7 @@ public class IgnoreList {
      */
     public boolean matches(final int position, final String check) throws
             PatternSyntaxException {
-        if (position < this.count()) {
-            return check.matches("(?i)" + this.get(position));
-        } else {
-            return false;
-        }
+        return position < count() && check.matches("(?i)" + get(position));
     }
 
     /**
@@ -134,7 +130,7 @@ public class IgnoreList {
      * @return String showing the pattern. ("" if position isn't valid)
      */
     public String get(final int position) {
-        if (position < this.count()) {
+        if (position < count()) {
             return ignoreInfo.get(position);
         } else {
             return "";
@@ -148,7 +144,7 @@ public class IgnoreList {
      * @param pattern New pattern
      */
     public void set(final int position, final String pattern) {
-        if (position < this.count()) {
+        if (position < count()) {
             ignoreInfo.set(position, pattern);
         }
     }
@@ -220,62 +216,87 @@ public class IgnoreList {
     protected static String regexToSimple(final String regex)
             throws UnsupportedOperationException {
         final StringBuilder res = new StringBuilder(regex.length());
-        boolean escaped = false;
-        boolean inchar = false;
+        final ConversionState state = new ConversionState();
 
         for (char part : regex.toCharArray()) {
-            if (inchar) {
-                inchar = false;
-
-                if (part == '*') {
-                    res.append(part);
-                    continue;
-                } else {
-                    res.append('?');
-                }
-            }
-
-            if (escaped) {
-                if (part == '?' || part == '*') {
-                    throw new UnsupportedOperationException("Cannot convert to"
-                            + " simple expression: ? or * is escaped.");
-                }
-
-                res.append(part);
-                escaped = false;
-            } else if (part == '\\') {
-                escaped = true;
-            } else if (part == '.') {
-                inchar = true;
-            } else if (part == '.' || part == '^' || part == '$' || part
-                    == '['
-                    || part == ']' || part == '\\' || part == '(' || part == ')'
-                    || part == '{' || part == '}' || part == '|' || part == '+'
-                    || part == '*' || part == '?') {
-                throw new UnsupportedOperationException("Cannot convert to"
-                        + " simple expression: unescaped special char: " + part);
+            if (state.getAndResetLastCharWasDot()) {
+                handleCharFollowingDot(state, res, part);
+            } else if (state.getAndResetEscaped()) {
+                handleEscapedChar(res, part);
             } else {
-                res.append(part);
+                handleNormalChar(state, res, part);
             }
         }
 
-        if (escaped) {
+        if (state.getAndResetEscaped()) {
             throw new UnsupportedOperationException("Cannot convert to "
                     + "simple expression: trailing backslash");
-        } else if (inchar) {
+        } else if (state.getAndResetLastCharWasDot()) {
             res.append('?');
         }
 
         return res.toString();
     }
 
+    /**
+     * Handles a single char that was preceded by a '.' when converting from a regex.
+     *
+     * @param state The current state of conversion.
+     * @param builder The builder to append data to.
+     * @param character The character in question.
+     */
+    private static void handleCharFollowingDot(final ConversionState state,
+            final StringBuilder builder, final char character) {
+        if (character == '*') {
+            builder.append('*');
+        } else {
+            builder.append('?');
+            handleNormalChar(state, builder, character);
+        }
+    }
+
+    /**
+     * Handles a single char that was escaped when converting from a regex.
+     *
+     * @param builder The builder to append data to.
+     * @param character The character in question.
+     */
+    private static void handleEscapedChar(final StringBuilder builder, final char character) {
+        if (character == '?' || character == '*') {
+            throw new UnsupportedOperationException("Cannot convert to"
+                    + " simple expression: ? or * is escaped.");
+        }
+
+        builder.append(character);
+    }
+
+    /**
+     * Handles a single normal character when converting from a regex.
+     *
+     * @param state The current state of conversion.
+     * @param builder The builder to append data to.
+     * @param character The character in question.
+     */
+    private static void handleNormalChar(final ConversionState state,
+            final StringBuilder builder, final char character) {
+        if (character == '\\') {
+            state.setEscaped();
+        } else if (character == '.') {
+            state.setLastCharWasDot();
+        } else if ("^$[](){}|+*?".indexOf(character) > -1) {
+            throw new UnsupportedOperationException("Cannot convert to"
+                    + " simple expression: unescaped special char: " + character);
+        } else {
+            builder.append(character);
+        }
+    }
+
     /**
      * Converts a simple expression to a regular expression.
      *
      * @param regex The simple expression to be converted
      * @return A corresponding regular expression
      */
-    @SuppressWarnings("fallthrough")
     protected static String simpleToRegex(final String regex) {
         final StringBuilder res = new StringBuilder(regex.length());
 
@@ -293,14 +314,14 @@ public class IgnoreList {
                 case '}':
                 case '|':
                 case '+':
-                    res.append('\\');
-                    res.append(part);
+                    res.append('\\').append(part);
                     break;
                 case '?':
                     res.append('.');
                     break;
                 case '*':
-                    res.append('.');
+                    res.append(".*");
+                    break;
                 default:
                     res.append(part);
                     break;
@@ -309,4 +330,35 @@ public class IgnoreList {
 
         return res.toString();
     }
+
+    /**
+     * Utility class to represent state while converting a regex to a simple form.
+     */
+    private static final class ConversionState {
+
+        private boolean escaped;
+        private boolean lastCharWasDot;
+
+        public boolean getAndResetLastCharWasDot() {
+            final boolean oldValue = lastCharWasDot;
+            lastCharWasDot = false;
+            return oldValue;
+        }
+
+        public void setLastCharWasDot() {
+            lastCharWasDot = true;
+        }
+
+        public boolean getAndResetEscaped() {
+            final boolean oldValue = escaped;
+            escaped = false;
+            return oldValue;
+        }
+
+        public void setEscaped() {
+            escaped = true;
+        }
+
+    }
+
 }

src/com/dmdirc/parser/common/MyInfo.java

@@ -22,12 +22,12 @@
 
 package com.dmdirc.parser.common;
 
+import com.dmdirc.parser.interfaces.Parser;
+
 /**
  * Contains User information.
  *
- * @author Shane Mc Cormack
- * @author Chris Smith
- * @see com.dmdirc.parser.interfaces.Parser
+ * @see Parser
  */
 public class MyInfo {
 
@@ -71,7 +71,7 @@ public class MyInfo {
             nickname = result;
             username = nickname;
             realname = nickname + " - DMDIrc";
-            altNickname = nickname + "-";
+            altNickname = nickname + '-';
         }
     }
 

src/com/dmdirc/parser/common/ParserError.java

@@ -24,8 +24,6 @@ package com.dmdirc.parser.common;
 
 /**
  * IRC Parser Error.
- *
- * @author Shane Mc Cormack
  */
 public final class ParserError {
     /** Error is potentially Fatal, Desync 99% Guaranteed! */

src/com/dmdirc/parser/common/SystemEncoder.java

@@ -27,9 +27,6 @@ import com.dmdirc.parser.interfaces.Encoder;
 /**
  * A basic {@link Encoder} implementation that just encodes messages using
  * the system's default charset.
- *
- * @since 0.6.5
- * @author chris
  */
 public class SystemEncoder implements Encoder {
 

src/com/dmdirc/parser/common/ThreadedParser.java

@@ -32,29 +32,31 @@ public abstract class ThreadedParser implements Parser {
 
     /** Parser Control Thread. */
     protected Thread controlThread;
+    /** Object to use to lock access to {@link #controlThread}. */
+    protected final Object controlThreadLock = new Object();
 
     @Override
     public void connect() {
-        synchronized (this) {
-            if (controlThread != null) {
-                // To ensure correct internal state, parsers must be recreated for
-                // new connections rather than being recycled.
-                throw new UnsupportedOperationException("This parser has already been running.");
-            } else {
-                controlThread = new Thread(new Runnable(){
+        synchronized (controlThreadLock) {
+            if (controlThread == null) {
+                controlThread = new Thread(new Runnable() {
                     @Override
                     public void run() {
                         ThreadedParser.this.run();
                     }
                 }, "Parser Thread");
                 controlThread.start();
+            } else {
+                // To ensure correct internal state, parsers must be recreated for
+                // new connections rather than being recycled.
+                throw new UnsupportedOperationException("This parser has already been running.");
             }
         }
     }
 
     @Override
     public void disconnect(final String message) {
-        synchronized (this) {
+        synchronized (controlThreadLock) {
             if (controlThread != null) {
                 controlThread.interrupt();
             }