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

   1 /*
   2  * XdccDownloader - ChannelNames.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 java.util.Collection;
  21
  22 import net.pterodactylus.irc.Connection;
  23 import net.pterodactylus.irc.Nickname;
  24
  25 /**
  26  * Notifies a listener that a list of nicknames has been retrieved for a
  27  * channel.
  28  *
  29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  30  */
  31 public class ChannelNicknames extends AbstractChannelEvent {
  32
  33         /** The nicknames. */
  34         private final Collection<Nickname> nicknames;
  35
  36         /**
  37          * Creates a new channel nicknames event.
  38          *
  39          * @param connection
  40          *              The connection the event occured on
  41          * @param channel
  42          *              The channel the nicknames are listed for
  43          * @param nicknames
  44          *              The nicknames
  45          */
  46         public ChannelNicknames(Connection connection, String channel, Collection<Nickname> nicknames) {
  47                 super(connection, channel);
  48                 this.nicknames = nicknames;
  49         }
  50
  51         //
  52         // ACCESSORS
  53         //
  54
  55         /**
  56          * Returns the nicknames retrieved for the channel.
  57          *
  58          * @return The nicknames retrieved for the channel
  59          */
  60         public Collection<Nickname> nicknames() {
  61                 return nicknames;
  62         }
  63
  64 }