Package sfs2x.client.core

Class BaseEvent

  • Direct Known Subclasses:
    SFSBuddyEvent, SFSEvent
    public class BaseEvent
extends java.lang.Object
    This is the base class of all the events dispatched by the SmartFoxServer 2X Java Client API. In particular, check the SFSEvent and SFSBuddyEvent children classes for more information.
    See Also:
    SFSEvent, SFSBuddyEvent

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseEvent​(java.lang.String type)
      * API internal usage only *
      BaseEvent​(java.lang.String type, java.util.Map<java.lang.String,​java.lang.Object> arguments)
      * API internal usage only *

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BaseEvent clone()
      * API internal usage only *
      java.util.Map<java.lang.String,​java.lang.Object> getArguments()
      Returns a Map<String, Object> containing the parameters of the event.
      java.lang.Object getTarget()
      * API internal usage only *
      java.lang.String getType()
      Returns the type of the event.
      void setArguments​(java.util.Map<java.lang.String,​java.lang.Object> arguments)
      * API internal usage only *
      void setTarget​(java.lang.Object target)
      * API internal usage only *
      java.lang.String toString()
      Generates a string containing all the properties of the BaseEvent object.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • BaseEvent

        public BaseEvent​(java.lang.String type)
        * API internal usage only *

      • BaseEvent

        public BaseEvent​(java.lang.String type,
                 java.util.Map<java.lang.String,​java.lang.Object> arguments)
        * API internal usage only *
        Parameters:
        type - The type of event.
        arguments - An object containing the parameters of the event.

    • Method Detail

      • getTarget

        public java.lang.Object getTarget()
        * API internal usage only *

      • setTarget

        public void setTarget​(java.lang.Object target)
        * API internal usage only *

      • getType

        public java.lang.String getType()
        Returns the type of the event.
        Returns:
        A string representing the type of the event.

      • toString

        public java.lang.String toString()
        Generates a string containing all the properties of the BaseEvent object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string containing all the properties of the BaseEvent object.

      • clone

        public BaseEvent clone()
        * API internal usage only *
        Returns:
        A new BaseEvent object that is identical to the original.

      • setArguments

        public void setArguments​(java.util.Map<java.lang.String,​java.lang.Object> arguments)
        * API internal usage only *

      • getArguments

        public java.util.Map<java.lang.String,​java.lang.Object> getArguments()
        Returns a Map<String, Object> containing the parameters of the event.
        Returns:
        A Map<String, Object> containing the parameters of the event.