net.sf.mud4j.effect
Interface EffectBehavior

All Known Implementing Classes:

DefaultEffectBehavior

public interface EffectBehavior

Effect behavior to decouple the behavior of managing effects from the objects that have effects Effectable so that the objects that implement the interface will only have to worry about providing a way to retrieve an EffectBehavior

Author:

Matthew Purland

Method Summary

void	addEffect(Effect effect) Add effect to behavior object.
void	clear() Clear all effects.
java.util.List<Effect>	getEffects() Get list of effects.
void	removeEffect(Effect effect) Remove effect from behavior object.

Method Detail

getEffects

java.util.List<Effect> getEffects()

Get list of effects.

Returns:

Returns a list of effects.

addEffect

void addEffect(Effect effect)
               throws EffectException

Add effect to behavior object.

Parameters:

effect - Effect to add.

Throws:

EffectException - in case adding an effect will not be possible.

removeEffect

void removeEffect(Effect effect)
                  throws EffectException

Remove effect from behavior object.

Parameters:

effect - Effect to remove.

Throws:

EffectException - in case removing an effect will not be possible.

clear

void clear()

Clear all effects.