net.jetrix.filter
Class CommandFilter

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

public class CommandFilter
extends GenericFilter

A filter executing a specific command. This filter is useful to add a command to a specific channel. For example:

 <channel name="duel">
   <filters>
     <filter name="command">
       <param name="class" value="net.jetrix.command.ModeCommand">
     </filter>
   </filters>
 </channel>
 

Version:

$Revision: 571 $, $Date: 2005-01-10 20:19:27 +0100 (lun., 10 janv. 2005) $

Author:

Emmanuel Bourg

Field Summary

Fields inherited from class net.jetrix.filter.GenericFilter

log

Fields inherited from class net.jetrix.filter.MessageFilter

config

Constructor Summary

CommandFilter()

Method Summary

String	getAuthor() Returns the author of this filter.
String	getDescription() Returns a short description of this filter.
String	getName() Returns the name of this filter.
String	getVersion() Returns the version of this filter
void	init() Called by the channel to indicate to a filter that the filter is being placed into service.
void	onMessage(CommandMessage m, List out)

Methods inherited from class net.jetrix.filter.GenericFilter

onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onMessage, onSpecial, process

Methods inherited from class net.jetrix.filter.MessageFilter

destroy, getChannel, getConfig, getProperty, isShared, setChannel, setConfig, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandFilter

public CommandFilter()

Method Detail

init

public void init()

Description copied from class: MessageFilter

Called by the channel to indicate to a filter that the filter is being placed into service.

Overrides:

init in class MessageFilter

onMessage

public void onMessage(CommandMessage m,
                      List out)

Overrides:

onMessage in class GenericFilter

getName

public String getName()

Description copied from class: MessageFilter

Returns the name of this filter.

Overrides:

getName in class MessageFilter

getDescription

public String getDescription()

Description copied from class: MessageFilter

Returns a short description of this filter.

Overrides:

getDescription in class MessageFilter

getVersion

public String getVersion()

Description copied from class: MessageFilter

Returns the version of this filter

Overrides:

getVersion in class MessageFilter

getAuthor

public String getAuthor()

Description copied from class: MessageFilter

Returns the author of this filter.

Overrides:

getAuthor in class MessageFilter