Remove currently unused parameter from event.
[xudocci.git] / src / main / java / net / pterodactylus / irc / event / NicknameChanged.java
1 /*
2  * XdccDownloader - NicknameChanged.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 client has changed its nickname.
25  *
26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
27  */
28 public class NicknameChanged extends AbstractConnectionEvent {
29
30         /** The client that changed its nickname. */
31         private final Source client;
32
33         /** The new nickname of the client. */
34         private final String newNickname;
35
36         /**
37          * Creates a new nickname changed event.
38          *
39          * @param connection
40          *              The connection the event occured on
41          * @param client
42          *              The client that changed its nickname
43          * @param newNickname
44          *              The new nickname of the client
45          */
46         public NicknameChanged(Connection connection, Source client, String newNickname) {
47                 super(connection);
48                 this.client = client;
49                 this.newNickname = newNickname;
50         }
51
52         //
53         // ACCESSORS
54         //
55
56         /**
57          * Returns the client that changed its nickname.
58          *
59          * @return The client that changed its nickname
60          */
61         public Source client() {
62                 return client;
63         }
64
65         /**
66          * Returns the new nickname of the client.
67          *
68          * @return The new nickname of the client
69          */
70         public String newNickname() {
71                 return newNickname;
72         }
73
74 }