Package org.schwering.irc.lib
Interface IRCEventListener
-
- All Superinterfaces:
java.util.EventListener
,IRCConstants
- All Known Implementing Classes:
IRCEventAdapter
public interface IRCEventListener extends java.util.EventListener, IRCConstants
Used as listener for incoming events like messages.The
IRCEventListener
is used by theIRCConnection.addEventListener(IRCEventListener)
method to add a listener which listens to the connection for incoming IRC events likePRIVMSG
s or numeric replies.Supported events:
- Connect
- Disconnect
- Error
- Invite
- Join
- Kick
- Private Message
- Mode (Chan)
- Mode (User)
- Nick
- Notice
- Numeric Reply
- Numeric Error
- Part
- Ping
- Quit
- Topic
For other, unkown events there's the
unknown
-method.- See Also:
IRCEventAdapter
,IRCConnection
-
-
Field Summary
-
Fields inherited from interface org.schwering.irc.lib.IRCConstants
ACTION_INDICATOR, BOLD_INDICATOR, COLOR_END_INDICATOR, COLOR_INDICATOR, COLOR_REVERSE_INDICATOR, ERR_ALREADYREGISTRED, ERR_BADCHANMASK, ERR_BADCHANNELKEY, ERR_BANNEDFROMCHAN, ERR_CANNOTSENDTOCHAN, ERR_CANTKILLSERVER, ERR_CHANNELISFULL, ERR_CHANOPRIVSNEEDED, ERR_ERRONEUSNICKNAME, ERR_FILEERROR, ERR_INVITEONLYCHAN, ERR_KEYSET, ERR_NEEDMOREPARAMS, ERR_NICKCOLLISION, ERR_NICKNAMEINUSE, ERR_NOADMININFO, ERR_NOLOGIN, ERR_NOMOTD, ERR_NONICKNAMEGIVEN, ERR_NOOPERHOST, ERR_NOORIGIN, ERR_NOPERMFORHOST, ERR_NOPRIVILEGES, ERR_NORECIPIENT, ERR_NOSERVICEHOST, ERR_NOSUCHCHANNEL, ERR_NOSUCHNICK, ERR_NOSUCHSERVER, ERR_NOTEXTTOSEND, ERR_NOTONCHANNEL, ERR_NOTOPLEVEL, ERR_NOTREGISTERED, ERR_PASSWDMISMATCH, ERR_SUMMONDISABLED, ERR_TOOMANYCHANNELS, ERR_TOOMANYTARGETS, ERR_UMODEUNKNOWNFLAG, ERR_UNKNOWNCOMMAND, ERR_UNKNOWNMODE, ERR_USERNOTINCHANNEL, ERR_USERONCHANNEL, ERR_USERSDISABLED, ERR_USERSDONTMATCH, ERR_WASNOSUCHNICK, ERR_WILDTOPLEVEL, ERR_YOUREBANNEDCREEP, ERR_YOUWILLBEBANNED, RPL_ADMINEMAIL, RPL_ADMINLOC1, RPL_ADMINLOC2, RPL_ADMINME, RPL_AUTHNAME, RPL_AWAY, RPL_BANLIST, RPL_CHANNELMODEIS, RPL_CLOSEEND, RPL_CLOSING, RPL_CREATED, RPL_ENDOFBANLIST, RPL_ENDOFINFO, RPL_ENDOFLINKS, RPL_ENDOFMOTD, RPL_ENDOFNAMES, RPL_ENDOFSERVICES, RPL_ENDOFSTATS, RPL_ENDOFUSERS, RPL_ENDOFWHO, RPL_ENDOFWHOIS, RPL_ENDOFWHOWAS, RPL_INFO, RPL_INFOSTART, RPL_INVITING, RPL_ISON, RPL_ISUPPORT, RPL_KILLDONE, RPL_LINKS, RPL_LIST, RPL_LISTEND, RPL_LISTSTART, RPL_LUSERCHANNELS, RPL_LUSERCLIENT, RPL_LUSERME, RPL_LUSEROP, RPL_LUSERUNKNOWN, RPL_MOTD, RPL_MOTDSTART, RPL_MYINFO, RPL_MYPORTIS, RPL_NAMREPLY, RPL_NONE, RPL_NOTOPIC, RPL_NOUSERS, RPL_NOWAWAY, RPL_REHASHING, RPL_SERVICE, RPL_SERVICEINFO, RPL_SERVLIST, RPL_SERVLISTEND, RPL_STATSCLINE, RPL_STATSCOMMANDS, RPL_STATSHLINE, RPL_STATSILINE, RPL_STATSKLINE, RPL_STATSLINKINFO, RPL_STATSLLINE, RPL_STATSNLINE, RPL_STATSOLINE, RPL_STATSQLINE, RPL_STATSUPTIME, RPL_STATSYLINE, RPL_SUMMONING, RPL_TIME, RPL_TOPIC, RPL_TOPICINFO, RPL_TRACECLASS, RPL_TRACECONNECTING, RPL_TRACEHANDSHAKE, RPL_TRACELINK, RPL_TRACELOG, RPL_TRACENEWTYPE, RPL_TRACEOPERATOR, RPL_TRACESERVER, RPL_TRACEUNKNOWN, RPL_TRACEUSER, RPL_UMODEIS, RPL_UNAWAY, RPL_USERHOST, RPL_USERS, RPL_USERSSTART, RPL_VERSION, RPL_WELCOME, RPL_WHOISCHANNELS, RPL_WHOISCHANOP, RPL_WHOISIDLE, RPL_WHOISOPERATOR, RPL_WHOISSERVER, RPL_WHOISUSER, RPL_WHOREPLY, RPL_WHOWASUSER, RPL_YOUREOPER, RPL_YOURHOST, UNDERLINE_INDICATOR
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
onDisconnected()
Fired when the own connection is broken.void
onError(int num, java.lang.String msg)
Fired when a numeric error is received.void
onError(java.lang.String msg)
Fired when anERROR
command is received.void
onInvite(java.lang.String chan, IRCUser user, java.lang.String passiveNick)
Fired when somebody is invited to a channel.void
onJoin(java.lang.String chan, IRCUser user)
Fired when somebody joins a channel.void
onKick(java.lang.String chan, IRCUser user, java.lang.String passiveNick, java.lang.String msg)
Fired when somebody is kicked from a channel.void
onMode(java.lang.String chan, IRCUser user, IRCModeParser modeParser)
Fired when an operator changes the modes of a channel.void
onMode(IRCUser user, java.lang.String passiveNick, java.lang.String mode)
Fired when somebody changes somebody's usermodes.void
onNick(IRCUser user, java.lang.String newNick)
Fired when somebody changes his nickname successfully.void
onNotice(java.lang.String target, IRCUser user, java.lang.String msg)
Fired when somebody sends aNOTICE
to a user or a group.void
onPart(java.lang.String chan, IRCUser user, java.lang.String msg)
Fired when somebody parts from a channel.void
onPing(java.lang.String ping)
Fired when aPING
comes in.void
onPrivmsg(java.lang.String target, IRCUser user, java.lang.String msg)
Fired when a user sends aPRIVMSG
to a user or to a group.void
onQuit(IRCUser user, java.lang.String msg)
Fired when somebody quits from the network.void
onRegistered()
Fired when the own connection is successfully established.void
onReply(int num, java.lang.String value, java.lang.String msg)
Fired when a numeric reply is received.void
onTopic(java.lang.String chan, IRCUser user, java.lang.String topic)
Fired when the topic is changed by operators.void
unknown(java.lang.String prefix, java.lang.String command, java.lang.String middle, java.lang.String trailing)
This event is fired when the incoming line can not be identified as a known event.
-
-
-
Method Detail
-
onRegistered
void onRegistered()
Fired when the own connection is successfully established. This is the case when the first PING? is received.
This happens between the connection is opened with a socket and the connection is registered: The client sends his information to the server (nickname, username). The server says hello to you by sending you someNOTICE
s. And if your nickname is invalid or in use or anything else is wrong with your nickname, it asks you for a new one.
-
onDisconnected
void onDisconnected()
Fired when the own connection is broken.
-
onError
void onError(java.lang.String msg)
Fired when anERROR
command is received.- Parameters:
msg
- The message of the error.
-
onError
void onError(int num, java.lang.String msg)
Fired when a numeric error is received. The server often sends numeric errors (wrong nickname etc.). Themsg
's format is different for every reply. All replies' formats are described in theIRCUtil
.- Parameters:
num
- The identifier (usually a 3-digit number).msg
- The message of the error.
-
onInvite
void onInvite(java.lang.String chan, IRCUser user, java.lang.String passiveNick)
Fired when somebody is invited to a channel.- Parameters:
chan
- The channel the user is invited to.user
- The user who invites another. Contains nick, username and host.passiveNick
- The nickname of the user who is invited by another user (passive).
-
onJoin
void onJoin(java.lang.String chan, IRCUser user)
Fired when somebody joins a channel.- Parameters:
chan
- The channel the person joins.user
- The user who joins. Contains nick, username and host.
-
onKick
void onKick(java.lang.String chan, IRCUser user, java.lang.String passiveNick, java.lang.String msg)
Fired when somebody is kicked from a channel.- Parameters:
chan
- The channel somebody is kicked from.user
- The user who kicks another user from a channel. Contains nick, username and host.passiveNick
- The nickname of the user who is kicked from a channel (passive).msg
- The message the active user has set. This is""
if no message was set.
-
onMode
void onMode(java.lang.String chan, IRCUser user, IRCModeParser modeParser)
Fired when an operator changes the modes of a channel. For example, he can set somebody as an operator, too, or take him the oper-status. Also keys, moderated and other channelmodes are fired here.- Parameters:
chan
- The channel in which the modes are changed.user
- The user who changes the modes. Contains nick, username and host.modeParser
- TheIRCModeParser
object which contains the parsed information about the modes which are changed.
-
onMode
void onMode(IRCUser user, java.lang.String passiveNick, java.lang.String mode)
Fired when somebody changes somebody's usermodes. Note that this event is not fired when a channel-mode is set, for example when someone sets another user as operator or the mode moderated.- Parameters:
user
- The user who changes the modes of another user or himself. Contains nick, username and host.passiveNick
- The nickname of the person whose modes are changed by another user or himself.mode
- The changed modes which are set.
-
onNick
void onNick(IRCUser user, java.lang.String newNick)
Fired when somebody changes his nickname successfully.- Parameters:
user
- The user who changes his nickname. Contains nick, username and host.newNick
- The new nickname of the user who changes his nickname.
-
onNotice
void onNotice(java.lang.String target, IRCUser user, java.lang.String msg)
Fired when somebody sends aNOTICE
to a user or a group.- Parameters:
target
- The channel or nickname the user sent aNOTICE
to.user
- The user who notices another person or a group. Contains nick, username and host.msg
- The message.
-
onPart
void onPart(java.lang.String chan, IRCUser user, java.lang.String msg)
Fired when somebody parts from a channel.- Parameters:
chan
- The channel somebody parts from.user
- The user who parts from a channel. Contains nick, username and host.msg
- The part-message which is optionally. If it's empty, msg is""
.
-
onPing
void onPing(java.lang.String ping)
Fired when aPING
comes in. The IRC server tests in different periods if the client is still there by sending PING <ping>. The client must response PONG <ping>.- Parameters:
ping
- The ping which is received from the server.
-
onPrivmsg
void onPrivmsg(java.lang.String target, IRCUser user, java.lang.String msg)
Fired when a user sends aPRIVMSG
to a user or to a group.- Parameters:
target
- The channel or nickname the user sent aPRIVMSG
to.user
- The user who sent thePRIVMSG
. Contains nick, username and host.msg
- The message the user transmits.
-
onQuit
void onQuit(IRCUser user, java.lang.String msg)
Fired when somebody quits from the network.- Parameters:
user
- The user who quits. Contains nick, username and host.msg
- The optional message.""
if no message is set by the user.
-
onReply
void onReply(int num, java.lang.String value, java.lang.String msg)
Fired when a numeric reply is received. For example,WHOIS
queries are answered by the server with numeric replies. Themsg
's format is different for every reply. All replies' formats are described in theIRCUtil
. The first word in thevalue
is always your own nickname!- Parameters:
num
- The numeric reply.value
- The first part of the message.msg
- The main part of the message.
-
onTopic
void onTopic(java.lang.String chan, IRCUser user, java.lang.String topic)
Fired when the topic is changed by operators. Note that the topic is given as a numeric reply fired inonReply
when you join a channel.- Parameters:
chan
- The channel where the topic is changed.user
- The user who changes the topic. Contains nick, username and host.topic
- The new topic.
-
unknown
void unknown(java.lang.String prefix, java.lang.String command, java.lang.String middle, java.lang.String trailing)
This event is fired when the incoming line can not be identified as a known event.- Parameters:
prefix
- The prefix of the incoming line.command
- The command of the incoming line.middle
- The part until the colon (:
).trailing
- The part behind the colon (:
).
-
-