Add base class for channel events.

This allows clients to listen for ChannelEvents and filter on
channel names, rather than having to handle every single
individual event type.

common/src/main/java/com/dmdirc/parser/events/ChannelActionEvent.java

 /**
  * Called when a person does an action in a channel.
  */
-public class ChannelActionEvent extends ParserEvent {
+public class ChannelActionEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String message;
     private final String host;
     public ChannelActionEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String message,
             final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelCTCPEvent.java

 /**
  * Called when a person sends a CTCP to a channel.
  */
-public class ChannelCTCPEvent extends ParserEvent {
+public class ChannelCTCPEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String type;
     private final String message;
     public ChannelCTCPEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String type,
             final String message, final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.type = checkNotNull(type);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelCTCPReplyEvent.java

 /**
  * Called when a person sends a CTCPRReply to a channel.
  */
-public class ChannelCTCPReplyEvent extends ParserEvent {
+public class ChannelCTCPReplyEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String type;
     private final String message;
     public ChannelCTCPReplyEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String type,
             final String message, final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.type = checkNotNull(type);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelEvent.java

+/*
+ * Copyright (c) 2006-2017 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.parser.events;
+
+import com.dmdirc.parser.interfaces.ChannelInfo;
+import com.dmdirc.parser.interfaces.Parser;
+import java.time.LocalDateTime;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Base class for events that are tied to a {@link ChannelInfo}.
+ */
+public abstract class ChannelEvent extends ParserEvent {
+
+    private final ChannelInfo channel;
+
+    public ChannelEvent(final Parser parser, final LocalDateTime date, final ChannelInfo channel) {
+        super(parser, date);
+        this.channel = checkNotNull(channel);
+    }
+
+    public ChannelInfo getChannel() {
+        return channel;
+    }
+
+}

common/src/main/java/com/dmdirc/parser/events/ChannelJoinEvent.java

 /**
  * Called When we, or another client joins a channel.
  */
-public class ChannelJoinEvent extends ParserEvent {
+public class ChannelJoinEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
 
     public ChannelJoinEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelKickEvent.java

 /**
  * Called when a person is kicked.
  */
-public class ChannelKickEvent extends ParserEvent {
+public class ChannelKickEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo kickedClient;
     private final ChannelClientInfo client;
     private final String reason;
     public ChannelKickEvent(final Parser parser, final LocalDateTime date, final ChannelInfo channel,
             final ChannelClientInfo kickedClient, final ChannelClientInfo client,
             final String reason, final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.kickedClient = checkNotNull(kickedClient);
         this.client = checkNotNull(client);
         this.reason = checkNotNull(reason);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getKickedClient() {
         return kickedClient;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelListModeEvent.java

 
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
-
 import java.time.LocalDateTime;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Called when all requested ListModes have been sent.
  */
-public class ChannelListModeEvent extends ParserEvent {
+public class ChannelListModeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final char mode;
 
     public ChannelListModeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final char mode) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.mode = mode;
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public char getMode() {
         return mode;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelMessageEvent.java

 /**
  * Called when a person sends a message to a channel.
  */
-public class ChannelMessageEvent extends ParserEvent {
+public class ChannelMessageEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String message;
     private final String host;
     public ChannelMessageEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String message,
             final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelModeChangeEvent.java

 /**
  * Called when the channel modes are changed or discovered.
  */
-public class ChannelModeChangeEvent extends ParserEvent {
+public class ChannelModeChangeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String host;
     private final String modes;
     public ChannelModeChangeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String host,
             final String modes) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.host = checkNotNull(host);
         this.modes = checkNotNull(modes);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelModeMessageEvent.java

 /**
  * Called when a person sends a Message to a channel with a mode prefix.
  */
-public class ChannelModeMessageEvent extends ParserEvent {
+public class ChannelModeMessageEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final char prefix;
     private final ChannelClientInfo client;
     private final String message;
     public ChannelModeMessageEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final char prefix, final ChannelClientInfo client,
             final String message, final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
-        this.prefix = checkNotNull(prefix);
+        super(parser, date, channel);
+        this.prefix = prefix;
         this.client = checkNotNull(client);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public char getPrefix() {
         return prefix;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelModeNoticeEvent.java

 /**
  * Called when a person sends a notice to a channel with a mode prefix.
  */
-public class ChannelModeNoticeEvent extends ParserEvent {
+public class ChannelModeNoticeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final char prefix;
     private final ChannelClientInfo client;
     private final String message;
     public ChannelModeNoticeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final char prefix, final ChannelClientInfo client,
             final String message, final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
-        this.prefix = checkNotNull(prefix);
+        super(parser, date, channel);
+        this.prefix = prefix;
         this.client = checkNotNull(client);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public char getPrefix() {
         return prefix;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelNamesEvent.java

 
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
-
 import java.time.LocalDateTime;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Called when a names reply is parsed.
  */
-public class ChannelNamesEvent extends ParserEvent {
-
-    private final ChannelInfo channel;
+public class ChannelNamesEvent extends ChannelEvent {
 
     public ChannelNamesEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
 }

common/src/main/java/com/dmdirc/parser/events/ChannelNickChangeEvent.java

 /**
  * Called when we or another user change nickname (Called once per channel the user is on).
  */
-public class ChannelNickChangeEvent extends ParserEvent {
+public class ChannelNickChangeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String oldNick;
 
     public ChannelNickChangeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String oldNick) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.oldNick = checkNotNull(oldNick);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelNonUserModeChangeEvent.java

 /**
  * Called when the channel modes are changed or discovered.
  */
-public class ChannelNonUserModeChangeEvent extends ParserEvent {
+public class ChannelNonUserModeChangeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String host;
     private final String modes;
     public ChannelNonUserModeChangeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String host,
             final String modes) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.host = checkNotNull(host);
         this.modes = checkNotNull(modes);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelNoticeEvent.java

 /**
  * Called when a person sends a notice to a channel.
  */
-public class ChannelNoticeEvent extends ParserEvent {
+public class ChannelNoticeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
-    private final ChannelClientInfo client;
+        private final ChannelClientInfo client;
     private final String message;
     private final String host;
 
     public ChannelNoticeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String message,
             final String host) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.message = checkNotNull(message);
         this.host = checkNotNull(host);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelOtherAwayStateEvent.java

 /**
  * Called when we go away, or come back.
  */
-public class ChannelOtherAwayStateEvent extends ParserEvent {
+public class ChannelOtherAwayStateEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final AwayState oldState;
     private final AwayState newState;
     public ChannelOtherAwayStateEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final AwayState oldState,
             final AwayState newState) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.oldState = checkNotNull(oldState);
         this.newState = checkNotNull(newState);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelPartEvent.java

 /**
  * Called When we, or another client parts a channel.
  */
-public class ChannelPartEvent extends ParserEvent {
+public class ChannelPartEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String reason;
 
     public ChannelPartEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String reason) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.reason = checkNotNull(reason);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelPasswordChangedEvent.java

 
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
-
 import java.time.LocalDateTime;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Called when a channel password changes.
  */
-public class ChannelPasswordChangedEvent extends ParserEvent {
+public class ChannelPasswordChangedEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
-
-    public ChannelPasswordChangedEvent(final Parser parser, final LocalDateTime date,
-                                  final ChannelInfo channel) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+    public ChannelPasswordChangedEvent(final Parser parser, final LocalDateTime date, final ChannelInfo channel) {
+        super(parser, date, channel);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
 }

common/src/main/java/com/dmdirc/parser/events/ChannelQuitEvent.java

 /**
  * Called When we, or another client quits IRC (Called once per channel the user was on).
  */
-public class ChannelQuitEvent extends ParserEvent {
+public class ChannelQuitEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String reason;
 
     public ChannelQuitEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String reason) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.reason = checkNotNull(reason);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelSelfJoinEvent.java

 
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
-
 import java.time.LocalDateTime;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Called when we join a channel.
  */
-public class ChannelSelfJoinEvent extends ParserEvent {
-
-    private final ChannelInfo channel;
+public class ChannelSelfJoinEvent extends ChannelEvent {
 
     public ChannelSelfJoinEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
 }

common/src/main/java/com/dmdirc/parser/events/ChannelSingleModeChangeEvent.java

 /**
  * Called when the channel modes are changed or discovered.
  */
-public class ChannelSingleModeChangeEvent extends ParserEvent {
+public class ChannelSingleModeChangeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo client;
     private final String host;
     private final String modes;
     public ChannelSingleModeChangeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo client, final String host,
             final String modes) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.client = checkNotNull(client);
         this.host = checkNotNull(host);
         this.modes = checkNotNull(modes);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getClient() {
         return client;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelTopicEvent.java

 
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
-
 import java.time.LocalDateTime;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Called when the topic is changed or discovered for the first time.
  */
-public class ChannelTopicEvent extends ParserEvent {
+public class ChannelTopicEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final boolean isJoinTopic;
 
     public ChannelTopicEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final boolean isJoinTopic) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.isJoinTopic = isJoinTopic;
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public boolean isJoinTopic() {
         return isJoinTopic;
     }

common/src/main/java/com/dmdirc/parser/events/ChannelUserModeChangeEvent.java

 /**
  *  Called when a users channel mode is changed.
  */
-public class ChannelUserModeChangeEvent extends ParserEvent {
+public class ChannelUserModeChangeEvent extends ChannelEvent {
 
-    private final ChannelInfo channel;
     private final ChannelClientInfo targetClient;
     private final ChannelClientInfo client;
     private final String host;
     public ChannelUserModeChangeEvent(final Parser parser, final LocalDateTime date,
             final ChannelInfo channel, final ChannelClientInfo targetClient,
             final ChannelClientInfo client, final String host, final String mode) {
-        super(parser, date);
-        this.channel = checkNotNull(channel);
+        super(parser, date, channel);
         this.targetClient = checkNotNull(targetClient);
         this.client = checkNotNull(client);
         this.host = checkNotNull(host);
         this.mode = checkNotNull(mode);
     }
 
-    public ChannelInfo getChannel() {
-        return channel;
-    }
-
     public ChannelClientInfo getTargetClient() {
         return targetClient;
     }