Package com.aquima.interactions.profile.events

Class ValueEvent

java.lang.Object
com.aquima.interactions.profile.events.ValueEvent
All Implemented Interfaces:
IEvent, IValueEvent
public final class ValueEvent extends Object implements IValueEvent
Event class holding the information of an event which will modify the attribute state.
Since:
5.0
Author:
O. Kerpershoek

  • Method Details

    • addEvent

      public static IEvent addEvent(IEntityInstance instance, IAttributeValue previousState, IPrimitiveValue attrValue)
      Constructs an add value event for the specified parameters.
      Parameters:
      instance - The instance of the attribute.
      previousState - The previous value of the attribute.
      attrValue - The value of the event.
      Returns:
      The value event for the specified parameters.

    • removeEvent

      public static IEvent removeEvent(IEntityInstance instance, IAttributeValue previousState, IPrimitiveValue attrValue)
      Constructs a remove value event for the specified parameters.
      Parameters:
      instance - The instance of the attribute.
      previousState - The previous value of the attribute.
      attrValue - The value of the event.
      Returns:
      The value event for the specified parameters.

    • setEvent

      public static IEvent setEvent(IEntityInstance instance, IAttributeValue previousState, IValue attrValue)
      Constructs a set value event for the specified parameters.
      Parameters:
      instance - The instance of the attribute.
      previousState - The previous value of the attribute.
      attrValue - The value of the event.
      Returns:
      The value event for the specified parameters.

    • clearEvent

      public static IEvent clearEvent(IEntityInstance instance, IAttributeValue previousState)
      Constructs a clear value event for the specified parameters.
      Parameters:
      instance - The instance of the attribute.
      previousState - The previous value of the attribute.
      Returns:
      The value event for the specified parameters.

    • getType

      public int getType()
      Description copied from interface: IEvent
      This method will return the type of the event. The type of the event is used to determine which event listeners should be invoked.
      Specified by:
      getType in interface IEvent
      Returns:
      The type of the event.

    • getEntityInstance

      public IEntityInstance getEntityInstance()
      Description copied from interface: IValueEvent
      This method returns the instance the value event will be applied on.
      Specified by:
      getEntityInstance in interface IValueEvent
      Returns:
      IEntityInstance, the entity instance that will be changed.

    • getAttributeValue

      public IAttributeValue getAttributeValue()
      Description copied from interface: IValueEvent
      This method returns the attribute state just before the event is processed.
      Specified by:
      getAttributeValue in interface IValueEvent
      Returns:
      The current state of the attribute.

    • getValue

      public IValue getValue()
      Description copied from interface: IValueEvent
      This method returns the value of the event.
      Specified by:
      getValue in interface IValueEvent
      Returns:
      The value that is to be added, set or removed from the attribute.

    • invokeEventHook

      public void invokeEventHook(IEventListener listener)
      Description copied from interface: IEvent
      The invoke event hook method will be triggered for every listener that is registered to receive events. The event class that implements this interface should check if the listener that is passed as argument supports this event, and invoke the correct method of the listener to notify the listener.
      For example: A context switch event can check if the listener contains a method 'onContextSwitch' and invoke that method when found.
      Specified by:
      invokeEventHook in interface IEvent
      Parameters:
      listener - IEventListener that should be notified of the event.