Class

org.scaladebugger.api.lowlevel.events

StandardEventManager

Related Doc: package events

Permalink

class StandardEventManager extends EventManager with Logging

Represents a manager for events coming in from a virtual machine.

Linear Supertypes
Logging, EventManager, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardEventManager
  2. Logging
  3. EventManager
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StandardEventManager(eventQueue: EventQueue, loopingTaskRunner: LoopingTaskRunner, autoStart: Boolean = true, onExceptionResume: Boolean = true)

    Permalink

    eventQueue

    The event queue whose events to pull off and process

    loopingTaskRunner

    The runner used to process events

    autoStart

    If true, starts the event processing automatically

    onExceptionResume

    If true, any event handler that throws an exception will count towards resuming the event set, otherwise it will cause the event set to not resume

Type Members

  1. type EventAndData = (Event, Seq[JDIEventDataResult])

    Permalink

    Represents a JDI event and any associated data retrieved from it.

    Represents a JDI event and any associated data retrieved from it.

    Definition Classes
    EventManager
  2. type EventHandler = (Event, Seq[JDIEventDataResult]) ⇒ Boolean

    Permalink

    Represents an event callback, receiving the event and returning whether or not to resume.

    Represents an event callback, receiving the event and returning whether or not to resume.

    Definition Classes
    EventManager
  3. implicit class LoggerExtras extends AnyRef

    Permalink
    Definition Classes
    Logging

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addEventDataStream(eventType: EventType, eventArguments: JDIEventArgument*): IdentityPipeline[EventAndData]

    Permalink

    Adds a new event data stream that tracks incoming JDI events and data collected from those events.

    Adds a new event data stream that tracks incoming JDI events and data collected from those events.

    eventType

    The type of JDI event to stream

    eventArguments

    The arguments used when determining whether or not to send the event down the stream

    returns

    The resulting event stream in the form of a pipeline of events and collected data

    Definition Classes
    EventManager
  5. def addEventDataStreamWithId(eventHandlerId: String, eventType: EventType, eventArguments: JDIEventArgument*): IdentityPipeline[EventAndData]

    Permalink

    Adds a new event data stream that tracks incoming JDI events and data collected from those events.

    Adds a new event data stream that tracks incoming JDI events and data collected from those events.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of JDI event to stream

    eventArguments

    The arguments used when determining whether or not to send the event down the stream

    returns

    The resulting event stream in the form of a pipeline of events and collected data

    Definition Classes
    EventManager
  6. def addEventHandler(eventType: EventType, eventHandler: (Event) ⇒ Boolean, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. The return value of the handler function contributes towards whether or not to resume the event set.

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  7. def addEventHandler(eventType: EventType, eventHandler: EventHandler, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. The return value of the handler function contributes towards whether or not to resume the event set.

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event and a collection of retrieved data from the event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  8. def addEventHandlerFromInfo(eventHandlerInfo: EventHandlerInfo): String

    Permalink

    Adds an event handler based on the specified information.

    Adds an event handler based on the specified information.

    eventHandlerInfo

    The information used to add the event hander

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  9. def addEventHandlerWithId(eventHandlerId: String, eventType: EventType, eventHandler: EventHandler, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. The return value of the handler function contributes towards whether or not to resume the event set.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event and a collection of retrieved data from the event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    StandardEventManagerEventManager
  10. def addEventHandlerWithId(eventHandlerId: String, eventType: EventType, eventHandler: (Event) ⇒ Boolean, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. The return value of the handler function contributes towards whether or not to resume the event set.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  11. def addEventStream(eventType: EventType, eventArguments: JDIEventArgument*): IdentityPipeline[Event]

    Permalink

    Adds a new event stream that tracks incoming JDI events.

    Adds a new event stream that tracks incoming JDI events.

    eventType

    The type of JDI event to stream

    eventArguments

    The arguments used when determining whether or not to send the event down the stream

    returns

    The resulting event stream in the form of a pipeline of events

    Definition Classes
    EventManager
  12. def addEventStreamWithId(eventHandlerId: String, eventType: EventType, eventArguments: JDIEventArgument*): IdentityPipeline[Event]

    Permalink

    Adds a new event stream that tracks incoming JDI events.

    Adds a new event stream that tracks incoming JDI events.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of JDI event to stream

    eventArguments

    The arguments used when determining whether or not to send the event down the stream

    returns

    The resulting event stream in the form of a pipeline of events

    Definition Classes
    EventManager
  13. def addResumingEventHandler(eventType: EventType, eventHandler: (Event) ⇒ Unit, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. This event automatically counts towards resuming the event set after completion.

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  14. def addResumingEventHandler(eventType: EventType, eventHandler: (Event, Seq[JDIEventDataResult]) ⇒ Unit, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. This event automatically counts towards resuming the event set after completion.

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event and a collection of retrieved data from the event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  15. def addResumingEventHandlerWithId(eventHandlerId: String, eventType: EventType, eventHandler: (Event) ⇒ Unit, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. This event automatically counts towards resuming the event set after completion.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  16. def addResumingEventHandlerWithId(eventHandlerId: String, eventType: EventType, eventHandler: (Event, Seq[JDIEventDataResult]) ⇒ Unit, eventArguments: JDIEventArgument*): String

    Permalink

    Adds the event function to this manager.

    Adds the event function to this manager. This event automatically counts towards resuming the event set after completion.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of the event to add a function

    eventHandler

    The function to add, taking the occurring event and a collection of retrieved data from the event

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the event handler

    Definition Classes
    EventManager
  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def eventHandlerTask(): Unit

    Permalink

    Represents the task to be added per event handler.

    Represents the task to be added per event handler. Can be overridden to perform different tasks.

    Attributes
    protected
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def getAllEventHandlerInfo: Seq[EventHandlerInfo]

    Permalink

    Retrieves information on all event handlers.

    Retrieves information on all event handlers.

    returns

    The collection of information on all event handlers

    Definition Classes
    StandardEventManagerEventManager
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def getEventHandler(id: String): Option[EventHandler]

    Permalink

    Retrieves the handler with the specified id.

    Retrieves the handler with the specified id.

    id

    The id of the handler to retrieve

    returns

    Some event handler if found, otherwise None

    Definition Classes
    StandardEventManagerEventManager
  26. def getHandlerIdsForEventType(eventType: EventType): Seq[String]

    Permalink

    Retrieves the collection of event handler functions for the specific event class.

    Retrieves the collection of event handler functions for the specific event class.

    eventType

    The type of event whose functions to retrieve

    returns

    The collection of event functions

    Definition Classes
    StandardEventManagerEventManager
  27. def getHandlersForEventType(eventType: EventType): Seq[EventHandler]

    Permalink

    Retrieves the collection of event handler functions for the specific event class.

    Retrieves the collection of event handler functions for the specific event class.

    eventType

    The type of event whose functions to retrieve

    returns

    The collection of event functions

    Definition Classes
    StandardEventManagerEventManager
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def isRunning: Boolean

    Permalink

    Indicates whether or not the event manager is processing events.

    Indicates whether or not the event manager is processing events.

    returns

    True if it is running, otherwise false

    Definition Classes
    StandardEventManagerEventManager
  31. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. def newEventId(): String

    Permalink

    Generates an id for a new event handler.

    Generates an id for a new event handler.

    returns

    The id as a string

    Attributes
    protected
    Definition Classes
    EventManager
  34. def newEventSetProcessor(eventSet: EventSet): EventSetProcessor

    Permalink

    Creates a new event set processor.

    Creates a new event set processor. Can be overridden.

    eventSet

    The event set to process

    returns

    The new event set processor instance

    Attributes
    protected
  35. def newWrapperEventHandler(eventHandler: EventHandler, eventArguments: Seq[JDIEventArgument]): EventHandler

    Permalink

    Generates a wrapper function around the event handler, using an argument processor to evaluate the provided arguments to determine whether or not to invoke the event handler as well as retrieve any requested data.

    Generates a wrapper function around the event handler, using an argument processor to evaluate the provided arguments to determine whether or not to invoke the event handler as well as retrieve any requested data.

    eventHandler

    The event handler to wrap

    eventArguments

    The arguments to use when determining if the event handler should be invoked and what data to be retrieved

    returns

    The wrapper around the event handler

    Attributes
    protected
  36. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. def removeEventHandler(id: String): Option[EventHandler]

    Permalink

    Removes the event function from this manager.

    Removes the event function from this manager.

    id

    The id of the event handler to remove

    returns

    Some event handler if removed, otherwise None

    Definition Classes
    StandardEventManagerEventManager
  39. def start(): Unit

    Permalink

    Begins the processing of events from the virtual machine.

    Begins the processing of events from the virtual machine.

    Definition Classes
    StandardEventManagerEventManager
  40. def stop(): Unit

    Permalink

    Ends the processing of events from the virtual machine.

    Ends the processing of events from the virtual machine.

    Definition Classes
    StandardEventManagerEventManager
  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  42. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def wrapAndAddEventHandler(eventHandlerId: String, eventType: EventType, eventHandler: EventHandler, eventArguments: JDIEventArgument*): String

    Permalink

    Wraps the provided event handler and adds it to the internal collection.

    Wraps the provided event handler and adds it to the internal collection.

    eventHandlerId

    The id to associate with the event handler

    eventType

    The type of the event to match against the handler

    eventHandler

    The event handler function to be wrapped

    eventArguments

    The arguments used when determining whether or not to invoke the event handler

    returns

    The id associated with the wrapped event handler

    Attributes
    protected

Inherited from Logging

Inherited from EventManager

Inherited from AnyRef

Inherited from Any

Ungrouped