net.jetrix.filter
Class GenericFilter

java.lang.Object
  net.jetrix.filter.MessageFilter
      net.jetrix.filter.GenericFilter

Direct Known Subclasses:

CommandFilter, FloodFilter, LogoFilter, StartFilter, StatsFilter, SuddenDeathFilter, TetrisFilter

public abstract class GenericFilter
extends MessageFilter

Defines a generic filter to be used and extended by filter developpers. GenericFilter makes writing filters easier by dispatching messages to an appropriate method according to the type of this message (onPline(), onStartGame(), etc...).

Version:

$Revision: 593 $, $Date: 2005-01-13 00:25:46 +0100 (jeu., 13 janv. 2005) $

Author:

Emmanuel Bourg

Field Summary

protected Logger

log

Fields inherited from class net.jetrix.filter.MessageFilter

config

Constructor Summary

GenericFilter()

Method Summary

void	onMessage(AddLineMessage m, List<Message> out)
void	onMessage(BlockBombMessage m, List<Message> out)
void	onMessage(BlockQuakeMessage m, List<Message> out)
void	onMessage(ClearLineMessage m, List<Message> out)
void	onMessage(ClearSpecialsMessage m, List<Message> out)
void	onMessage(CommandMessage m, List<Message> out)
void	onMessage(EndGameMessage m, List<Message> out)
void	onMessage(FieldMessage m, List<Message> out)
void	onMessage(FourLinesAddedMessage m, List<Message> out)
void	onMessage(GmsgMessage m, List<Message> out)
void	onMessage(GravityMessage m, List<Message> out)
void	onMessage(JoinMessage m, List<Message> out)
void	onMessage(LeaveMessage m, List<Message> out)
void	onMessage(LevelMessage m, List<Message> out)
void	onMessage(Message m) Message pre-processing.
void	onMessage(Message m, List<Message> out)
void	onMessage(NewGameMessage m, List<Message> out)
void	onMessage(NukeFieldMessage m, List<Message> out)
void	onMessage(OneLineAddedMessage m, List<Message> out)
void	onMessage(PauseMessage m, List<Message> out)
void	onMessage(PlayerLostMessage m, List<Message> out)
void	onMessage(PlayerNumMessage m, List<Message> out)
void	onMessage(PlayerWonMessage m, List<Message> out)
void	onMessage(PlineActMessage m, List<Message> out)
void	onMessage(PlineMessage m, List<Message> out)
void	onMessage(RandomClearMessage m, List<Message> out)
void	onMessage(ResumeMessage m, List<Message> out)
void	onMessage(StartGameMessage m, List<Message> out)
void	onMessage(StopGameMessage m, List<Message> out)
void	onMessage(SwitchFieldsMessage m, List<Message> out)
void	onMessage(TeamMessage m, List<Message> out)
void	onMessage(TwoLinesAddedMessage m, List<Message> out)
void	onSpecial(SpecialMessage m, List<Message> out) Special block message pre-processing.
void	process(Message m, List<Message> out) Process a message and outputs messages to the specified List.

Methods inherited from class net.jetrix.filter.MessageFilter

destroy, getAuthor, getChannel, getConfig, getDescription, getName, getProperty, getVersion, init, isShared, setChannel, setConfig, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

log

protected Logger log

Constructor Detail

GenericFilter

public GenericFilter()

Method Detail

process

public final void process(Message m,
                          List<Message> out)

Description copied from class: MessageFilter

Process a message and outputs messages to the specified List.

Specified by:

process in class MessageFilter

onMessage

public void onMessage(Message m)

Message pre-processing. This method is called at the beginning of the process(Message m, List out) method and allow custom processing for all filtered messages.

onMessage

public void onMessage(Message m,
                      List<Message> out)

onMessage

public void onMessage(PlineMessage m,
                      List<Message> out)

onMessage

public void onMessage(PlineActMessage m,
                      List<Message> out)

onMessage

public void onMessage(TeamMessage m,
                      List<Message> out)

onMessage

public void onMessage(JoinMessage m,
                      List<Message> out)

onMessage

public void onMessage(LeaveMessage m,
                      List<Message> out)

onMessage

public void onMessage(PlayerNumMessage m,
                      List<Message> out)

onMessage

public void onMessage(StartGameMessage m,
                      List<Message> out)

onMessage

public void onMessage(StopGameMessage m,
                      List<Message> out)

onMessage

public void onMessage(NewGameMessage m,
                      List<Message> out)

onMessage

public void onMessage(EndGameMessage m,
                      List<Message> out)

onMessage

public void onMessage(PauseMessage m,
                      List<Message> out)

onMessage

public void onMessage(ResumeMessage m,
                      List<Message> out)

onMessage

public void onMessage(GmsgMessage m,
                      List<Message> out)

onSpecial

public void onSpecial(SpecialMessage m,
                      List<Message> out)

Special block message pre-processing. This method is called for all specials filtered and allow custom processing for all specials (lines added, blockbomb switchs, etc...).

onMessage

public void onMessage(LevelMessage m,
                      List<Message> out)

onMessage

public void onMessage(FieldMessage m,
                      List<Message> out)

onMessage

public void onMessage(PlayerLostMessage m,
                      List<Message> out)

onMessage

public void onMessage(PlayerWonMessage m,
                      List<Message> out)

onMessage

public void onMessage(CommandMessage m,
                      List<Message> out)

onMessage

public void onMessage(OneLineAddedMessage m,
                      List<Message> out)

onMessage

public void onMessage(TwoLinesAddedMessage m,
                      List<Message> out)

onMessage

public void onMessage(FourLinesAddedMessage m,
                      List<Message> out)

onMessage

public void onMessage(AddLineMessage m,
                      List<Message> out)

onMessage

public void onMessage(ClearLineMessage m,
                      List<Message> out)

onMessage

public void onMessage(NukeFieldMessage m,
                      List<Message> out)

onMessage

public void onMessage(RandomClearMessage m,
                      List<Message> out)

onMessage

public void onMessage(SwitchFieldsMessage m,
                      List<Message> out)

onMessage

public void onMessage(ClearSpecialsMessage m,
                      List<Message> out)

onMessage

public void onMessage(GravityMessage m,
                      List<Message> out)

onMessage

public void onMessage(BlockQuakeMessage m,
                      List<Message> out)

onMessage

public void onMessage(BlockBombMessage m,
                      List<Message> out)