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

   1 /*
   2  * XdccDownloader - PrivateMessageReceived.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 /**
  24  * Notifies a listener that a new private message was received.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class PrivateMessageReceived extends AbstractConnectionEvent {
  29
  30         /** The source of the message. */
  31         private final Source source;
  32
  33         /** The text of the message. */
  34         private final String message;
  35
  36         /**
  37          * Creates a new private message received event.
  38          *
  39          * @param connection
  40          *              The connection the event occured on
  41          * @param source
  42          *              The source of the message
  43          * @param message
  44          *              The text of the message
  45          */
  46         public PrivateMessageReceived(Connection connection, Source source, String message) {
  47                 super(connection);
  48                 this.source = source;
  49                 this.message = message;
  50         }
  51
  52         //
  53         // ACCESSORS
  54         //
  55
  56         /**
  57          * Returns the source of the message.
  58          *
  59          * @return The source of the message
  60          */
  61         public Source source() {
  62                 return source;
  63         }
  64
  65         /**
  66          * Returns the text of the message.
  67          *
  68          * @return The text of the message
  69          */
  70         public String message() {
  71                 return message;
  72         }
  73
  74 }