de.cau.cs.kieler.core.kivi.triggers
Class EffectTrigger.EffectTriggerState<Effect extends IEffect>

java.lang.Object
  extended by de.cau.cs.kieler.core.kivi.AbstractTriggerState
      extended by de.cau.cs.kieler.core.kivi.triggers.EffectTrigger.EffectTriggerState<Effect>
Type Parameters:
Effect - the effect class contained in this trigger state
All Implemented Interfaces:
ITriggerState
Enclosing class:
EffectTrigger

public static class EffectTrigger.EffectTriggerState<Effect extends IEffect>
extends AbstractTriggerState

The trigger state for recently executed effects.

Rating red

Constructor Summary
EffectTrigger.EffectTriggerState()
          Default constructor.
EffectTrigger.EffectTriggerState(Effect e, boolean undo)
          Create a new effect trigger state for the given effect.
 
Method Summary
 Effect getEffect()
          Get the effect.
 Class<?> getKeyClass()
          Get the class for identifying the type of trigger state.
 Class<? extends ITrigger> getTriggerClass()
          Get the trigger class associated with this trigger state.
 boolean isUndo()
          Checks whether the effect was undone or not.
 String toString()
           
 
Methods inherited from class de.cau.cs.kieler.core.kivi.AbstractTriggerState
finish, getSequenceNumber, merge
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EffectTrigger.EffectTriggerState

public EffectTrigger.EffectTriggerState()
Default constructor.


EffectTrigger.EffectTriggerState

public EffectTrigger.EffectTriggerState(Effect e,
                                        boolean undo)
Create a new effect trigger state for the given effect.

Parameters:
e - the effect
undo - true if the effect was undone
Method Detail

getEffect

public Effect getEffect()
Get the effect. May be null if the effect never was executed

Returns:
the effect

isUndo

public boolean isUndo()
Checks whether the effect was undone or not.

Returns:
true if undone, false if executed

getTriggerClass

public Class<? extends ITrigger> getTriggerClass()
Get the trigger class associated with this trigger state.

Returns:
the trigger class

getKeyClass

public Class<?> getKeyClass()
Description copied from class: AbstractTriggerState
Get the class for identifying the type of trigger state. Usually this is the same as getClass().

Specified by:
getKeyClass in interface ITriggerState
Overrides:
getKeyClass in class AbstractTriggerState
Returns:
the key class

toString

public String toString()
Overrides:
toString in class AbstractTriggerState