Package org.apache.wiki.event

Class WikiEvent

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ERROR
      Indicates a exception or error state.
      static int UNDEFINED
      Indicates an undefined state.

      • Fields inherited from class java.util.EventObject

        source

    • Constructor Summary

      Constructors 
      Constructor Description
      WikiEvent​(java.lang.Object src, int type)
      Constructs an instance of this event.
      WikiEvent​(java.lang.Object src, int type, java.lang.Object... args)
      Constructs an instance of this event.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String eventName()
      Returns a textual representation of an event type.
      <T> T getArg​(int index, java.lang.Class<T> cls)
      Returns the requested arg, if any.
      java.lang.Object[] getArgs()
      Returns the args associated to src, if any.
      <T> T getSrc()
      Convenience method that returns the typed object to which the event applied.
      int getType()
      Returns the type of this event.
      java.lang.String getTypeDescription()
      Returns a String (human-readable) description of an event type.
      long getWhen()
      Returns the timestamp of when this WikiEvent occurred.
      static boolean isValidType​(int type)
      Returns true if the int value is a valid WikiEvent type.
      protected void setType​(int type)
      Sets the type of this event.
      java.lang.String toString()
      Prints a String (human-readable) representation of this object.

      • Methods inherited from class java.util.EventObject

        getSource

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • WikiEvent

        public WikiEvent​(java.lang.Object src,
                 int type)
        Constructs an instance of this event.
        Parameters:
        src - the Object that is the source of the event.
        type - the event type.

      • WikiEvent

        public WikiEvent​(java.lang.Object src,
                 int type,
                 java.lang.Object... args)
        Constructs an instance of this event.
        Parameters:
        src - the Object that is the source of the event.
        type - the event type.

    • Method Detail

      • getSrc

        public <T> T getSrc()
        Convenience method that returns the typed object to which the event applied.
        Returns:
        the typed object to which the event applied.

      • getWhen

        public long getWhen()
        Returns the timestamp of when this WikiEvent occurred.
        Returns:
        this event's timestamp
        Since:
        2.4.74

      • setType

        protected void setType​(int type)
        Sets the type of this event. Validation of acceptable type values is the responsibility of each subclass.
        Parameters:
        type - the type of this WikiEvent.

      • getType

        public int getType()
        Returns the type of this event.
        Returns:
        the type of this WikiEvent. See the enumerated values defined in WikiEvent).

      • getArgs

        public java.lang.Object[] getArgs()
        Returns the args associated to src, if any.
        Returns:
        args associated to src, if any.

      • getArg

        public <T> T getArg​(int index,
                    java.lang.Class<T> cls)
        Returns the requested arg, if any.
        Returns:
        requested arg or null.

      • getTypeDescription

        public java.lang.String getTypeDescription()
        Returns a String (human-readable) description of an event type. This should be subclassed as necessary.
        Returns:
        the String description

      • isValidType

        public static boolean isValidType​(int type)
        Returns true if the int value is a valid WikiEvent type. Because the WikiEvent class does not itself any event types, this method returns true if the event type is anything except ERROR or UNDEFINED. This method is meant to be subclassed as appropriate.
        Parameters:
        type - The value to test.
        Returns:
        true, if the value is a valid WikiEvent type.

      • eventName

        public java.lang.String eventName()
        Returns a textual representation of an event type.
        Returns:
        the String representation

      • toString

        public java.lang.String toString()
        Prints a String (human-readable) representation of this object. This should be subclassed as necessary.
        Overrides:
        toString in class java.util.EventObject
        Returns:
        the String representation
        See Also:
        Object.toString()