src/main/java/net/pterodactylus/irc/event/ChannelLeft.java

   1 /*
   2  * XdccDownloader - ChannelLeft.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.irc.event;
  19
  20 import net.pterodactylus.irc.Connection;
  21 import net.pterodactylus.irc.Source;
  22
  23 import com.google.common.base.Optional;
  24
  25 /**
  26  * Event that notifies a listener that a client has left a channel.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public class ChannelLeft extends AbstractChannelEvent {
  31
  32         /** The parting client. */
  33         private final Source client;
  34
  35         /** The message given by the client. */
  36         private final Optional<String> message;
  37
  38         /**
  39          * Creates a new channel joined event.
  40          *
  41          * @param connection
  42          *              The connection that joined the channel
  43          * @param channel
  44          *              The channel being left
  45          * @param message
  46          *              The message given by the client
  47          */
  48         public ChannelLeft(Connection connection, String channel, Source client, Optional<String> message) {
  49                 super(connection, channel);
  50                 this.client = client;
  51                 this.message = message;
  52         }
  53
  54         //
  55         // ACCESSORS
  56         //
  57
  58         /**
  59          * Returns the client that joined the channel.
  60          *
  61          * @return The client that joined the channel
  62          */
  63         public Source client() {
  64                 return client;
  65         }
  66
  67         /**
  68          * Returns the message given by the client.
  69          *
  70          * @return The message given by the client
  71          */
  72         public Optional<String> message() {
  73                 return message;
  74         }
  75
  76 }