org.schwering.irc.lib

Class IRCEventAdapter

java.lang.Object

org.schwering.irc.lib.IRCEventAdapter

All Implemented Interfaces:

EventListener, IRCEventListener, IRCConstants

public class IRCEventAdapter
extends Object
implements IRCEventListener

A empty implementation if IRCEventListener.

Author:

Christoph Schwering <schwering@gmail.com>

See Also:

IRCEventListener

Field Summary

Fields inherited from interface org.schwering.irc.lib.util.IRCConstants

BOLD_INDICATOR, COLOR_END_INDICATOR, COLOR_INDICATOR, COLOR_REVERSE_INDICATOR, UNDERLINE_INDICATOR

Constructor Summary

Constructors

Constructor and Description
IRCEventAdapter() The default and only constructor does nothing.

Method Summary

Modifier and Type	Method and Description
void	onDisconnected() Does nothing in this implementation.
void	onError(int num, String msg) Does nothing in this implementation.
void	onError(String msg) Does nothing in this implementation.
void	onInvite(String chan, IRCUser user, String passiveNick) Does nothing in this implementation.
void	onJoin(String chan, IRCUser user) Does nothing in this implementation.
void	onKick(String chan, IRCUser user, String passiveNick, String msg) Does nothing in this implementation.
void	onMode(IRCUser user, String passiveNick, String mode) Does nothing in this implementation.
void	onMode(String chan, IRCUser user, IRCModeParser modeParser) Does nothing in this implementation.
void	onNick(IRCUser user, String newNick) Does nothing in this implementation.
void	onNotice(String target, IRCUser user, String msg) Does nothing in this implementation.
void	onPart(String chan, IRCUser user, String msg) Does nothing in this implementation.
void	onPing(String ping) Does nothing in this implementation.
void	onPrivmsg(String target, IRCUser user, String msg) Does nothing in this implementation.
void	onQuit(IRCUser user, String msg) Does nothing in this implementation.
void	onRegistered() Does nothing in this implementation.
void	onReply(int num, String value, String msg) Does nothing in this implementation.
void	onTopic(String chan, IRCUser user, String topic) Does nothing in this implementation.
void	unknown(String prefix, String command, String middle, String trailing) Does nothing in this implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IRCEventAdapter

public IRCEventAdapter()

The default and only constructor does nothing.

Method Detail

onRegistered

public void onRegistered()

Does nothing in this implementation.

Specified by:

onRegistered in interface IRCEventListener

See Also:

IRCEventListener.onRegistered()

onDisconnected

public void onDisconnected()

Does nothing in this implementation.

Specified by:

onDisconnected in interface IRCEventListener

See Also:

IRCEventListener.onDisconnected()

onError

public void onError(String msg)

Does nothing in this implementation.

Specified by:

onError in interface IRCEventListener

Parameters:

msg - The message of the error.

See Also:

IRCEventListener.onError(String)

onError

public void onError(int num,
                    String msg)

Does nothing in this implementation.

Specified by:

onError in interface IRCEventListener

Parameters:

num - The identifier (usually a 3-digit number).

msg - The message of the error.

See Also:

IRCEventListener.onError(int, String)

onInvite

public void onInvite(String chan,
                     IRCUser user,
                     String passiveNick)

Does nothing in this implementation.

Specified by:

onInvite in interface IRCEventListener

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).

See Also:

IRCEventListener.onInvite(String, IRCUser, String)

onJoin

public void onJoin(String chan,
                   IRCUser user)

Does nothing in this implementation.

Specified by:

onJoin in interface IRCEventListener

Parameters:

chan - The channel the person joins.

user - The user who joins. Contains nick, username and host.

See Also:

IRCEventListener.onJoin(String, IRCUser)

onKick

public void onKick(String chan,
                   IRCUser user,
                   String passiveNick,
                   String msg)

Does nothing in this implementation.

Specified by:

onKick in interface IRCEventListener

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.

See Also:

IRCEventListener.onKick(String, IRCUser, String, String)

onMode

public void onMode(String chan,
                   IRCUser user,
                   IRCModeParser modeParser)

Does nothing in this implementation.

Specified by:

onMode in interface IRCEventListener

Parameters:

chan - The channel in which the modes are changed.

user - The user who changes the modes. Contains nick, username and host.

modeParser - The IRCModeParser object which contains the parsed information about the modes which are changed.

See Also:

IRCEventListener.onMode(String, IRCUser, IRCModeParser)

onMode

public void onMode(IRCUser user,
                   String passiveNick,
                   String mode)

Does nothing in this implementation.

Specified by:

onMode in interface IRCEventListener

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.

See Also:

IRCEventListener.onMode(IRCUser, String, String)

onNick

public void onNick(IRCUser user,
                   String newNick)

Does nothing in this implementation.

Specified by:

onNick in interface IRCEventListener

Parameters:

user - The user who changes his nickname. Contains nick, username and host.

newNick - The new nickname of the user who changes his nickname.

See Also:

IRCEventListener.onNick(IRCUser, String)

onNotice

public void onNotice(String target,
                     IRCUser user,
                     String msg)

Does nothing in this implementation.

Specified by:

onNotice in interface IRCEventListener

Parameters:

target - The channel or nickname the user sent a NOTICE to.

user - The user who notices another person or a group. Contains nick, username and host.

msg - The message.

See Also:

IRCEventListener.onNotice(String, IRCUser, String)

onPart

public void onPart(String chan,
                   IRCUser user,
                   String msg)

Does nothing in this implementation.

Specified by:

onPart in interface IRCEventListener

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 "".

See Also:

IRCEventListener.onPart(String, IRCUser, String)

onPing

public void onPing(String ping)

Does nothing in this implementation.

Specified by:

onPing in interface IRCEventListener

Parameters:

ping - The ping which is received from the server.

See Also:

IRCEventListener.onPing(String)

onPrivmsg

public void onPrivmsg(String target,
                      IRCUser user,
                      String msg)

Does nothing in this implementation.

Specified by:

onPrivmsg in interface IRCEventListener

Parameters:

target - The channel or nickname the user sent a PRIVMSG to.

user - The user who sent the PRIVMSG. Contains nick, username and host.

msg - The message the user transmits.

See Also:

IRCEventListener.onPrivmsg(String, IRCUser, String)

onQuit

public void onQuit(IRCUser user,
                   String msg)

Does nothing in this implementation.

Specified by:

onQuit in interface IRCEventListener

Parameters:

user - The user who quits. Contains nick, username and host.

msg - The optional message. "" if no message is set by the user.

See Also:

IRCEventListener.onQuit(IRCUser, String)

onReply

public void onReply(int num,
                    String value,
                    String msg)

Does nothing in this implementation.

Specified by:

onReply in interface IRCEventListener

Parameters:

num - The numeric reply.

value - The first part of the message.

msg - The main part of the message.

See Also:

IRCEventListener.onReply(int, String, String)

onTopic

public void onTopic(String chan,
                    IRCUser user,
                    String topic)

Does nothing in this implementation.

Specified by:

onTopic in interface IRCEventListener

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.

See Also:

IRCEventListener.onTopic(String, IRCUser, String)

unknown

public void unknown(String prefix,
                    String command,
                    String middle,
                    String trailing)

Does nothing in this implementation.

Specified by:

unknown in interface IRCEventListener

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 (:).

See Also:

IRCEventListener.unknown(String, String, String, String)