kernel

Class AbstractCommandFilter

java.lang.Object

kernel.AbstractCommandFilter

All Implemented Interfaces:

CommandFilter

Direct Known Subclasses:

BuriedAgentsCommandFilter, DeadAgentsCommandFilter, WrongTimeCommandFilter

public abstract class AbstractCommandFilter
extends java.lang.Object
implements CommandFilter

An abstract base class for command filters.

Constructor Summary

Constructors

Constructor and Description
AbstractCommandFilter()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	allowed(Command command, KernelState state) Find out if a particular command is allowed.
void	filter(java.util.Collection<Command> commands, KernelState state) Filter a set of agent commands.
void	initialise(Config config) Initialise this filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommandFilter

public AbstractCommandFilter()

Method Detail

initialise

public void initialise(Config config)

Description copied from interface: CommandFilter

Initialise this filter.

Specified by:

initialise in interface CommandFilter

Parameters:

config - The kernel configuration.

filter

public void filter(java.util.Collection<Command> commands,
                   KernelState state)

Description copied from interface: CommandFilter

Filter a set of agent commands. Any illegal commands should be removed from the given collection.

Specified by:

filter in interface CommandFilter

Parameters:

commands - The commands to filter. This collection should be modified to remove any illegal commands.

state - The state of the kernel.

allowed

protected abstract boolean allowed(Command command,
                                   KernelState state)

Find out if a particular command is allowed.

Parameters:

command - The command.

state - The kernel state.

Returns:

True iff the command is allowed.