Package com.iizix.event

Class RefreshEvent

java.lang.Object
com.iizix.event.GEvent
com.iizix.event.SinkEvent
com.iizix.event.RefreshEvent
All Implemented Interfaces:
IPostEventProcessing
public class RefreshEvent extends SinkEvent
Event indicating a refresh is required of a certain type, e.g. change of language code.
Author:
Christopher Mindus

  • Constructor Details

    • RefreshEvent

      public RefreshEvent(GProp<?> source, IClientSessionGyro clientGyro, RefreshEvent.Type type)
      Constructs a new sinking refresh event of the specified type.
      Parameters:
      source - The source property causing the change.
      clientGyro - The client session that caused the refresh.
      type - The refresh type.
      Throws:
      NullPointerException - If type is null.
      See Also:

  • Method Details

    • getClientSessionGyro

      public IClientSessionGyro getClientSessionGyro()
      The client session that caused the refresh.
      Returns:
      The client session gyro, or null if not from a client session.

    • getType

      public RefreshEvent.Type getType()
      Gets the refresh type.
      Returns:
      The type of refresh.

    • isRefreshEvent

      public boolean isRefreshEvent()
      Returns true if this is a refresh event.
      Overrides:
      isRefreshEvent in class GEvent
      Returns:
      true if this is a RefreshEvent: always true.

    • paramString

      protected StringBuilder paramString(StringBuilder buf)
      Returns the parameter string representing the state of this event. This string is useful for debugging. Super classes adds extra information to the string by preceding it with a comma followed by the extra information.
      Overrides:
      paramString in class GEvent
      Parameters:
      buf - The StringBuilder to append the string to.
      Returns:
      The StringBuilder, i.e. the buf input parameter.