c

org.scaladebugger.api.utils

PendingActionManager

class PendingActionManager[T] extends AnyRef

Represents a manager of pending actions that can be added and performed.

T

The type of information associated with the action

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PendingActionManager
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PendingActionManager()

Type Members

  1. type ActionData = T

    Represents the data associated with an action

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addPendingAction(actionData: ActionData, action: Action): ActionId

    Adds the action to a new collection of actions.

    Adds the action to a new collection of actions.

    actionData

    The data about the action being added

    action

    The action to add

    returns

    The id of the collection where the action was added

  5. def addPendingActionWithId(actionId: ActionId, actionInfoData: ActionData, action: Action): ActionId

    Adds the action to a collection under the specified id.

    Adds the action to a collection under the specified id.

    actionId

    The id of the collection of actions to add to

    actionInfoData

    The data about the action being added

    action

    The action to add

    returns

    The id of the collection where the action was added

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def cleanupActions(): Unit

    Removes any action collection that is null or empty.

    Removes any action collection that is null or empty.

    Attributes
    protected
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def getPendingActionData(predicate: (ActionInfo[ActionData]) ⇒ Boolean): Seq[ActionData]

    Retrieves a collection of information for actions using the provided predicate.

    Retrieves a collection of information for actions using the provided predicate.

    predicate

    The predicate to use when looking for actions based on their information (true indicates include the action)

    returns

    The collection of information for actions

  14. def getPendingActionDataWithId(actionId: ActionId): Option[Seq[ActionData]]

    Retrieves a collection of information for actions with the specified id.

    Retrieves a collection of information for actions with the specified id.

    actionId

    The id of the collection of actions to retrieve

    returns

    Some collection of actions if the id exists, otherwise None

  15. def getPendingActions(predicate: (ActionInfo[ActionData]) ⇒ Boolean): Seq[ActionInfo[ActionData]]

    Retrieves a collection of actions using the provided predicate.

    Retrieves a collection of actions using the provided predicate.

    predicate

    The predicate to use when looking for actions based on their information (true indicates include the action)

    returns

    The collection of actions and their information

  16. def getPendingActionsWithId(actionId: ActionId): Option[Seq[ActionInfo[ActionData]]]

    Retrieves a collection of actions by the specified id.

    Retrieves a collection of actions by the specified id.

    actionId

    The id of the collection of actions to retrieve

    returns

    Some collection of actions if the id exists, otherwise None

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def newActionId(): ActionId

    Generates an id for a new action.

    Generates an id for a new action.

    returns

    The id as a string

    Attributes
    protected
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def processActionCollectionMap(actionCollectionMap: Map[ActionId, Seq[ActionInfo[ActionData]]]): Seq[ActionInfo[ActionData]]

    Processes a map of collections of actions.

    Processes a map of collections of actions.

    actionCollectionMap

    The map of action id -> action collection whose actions to process

    returns

    The collection of information of actions that were successfully processed

    Attributes
    protected
  24. def processActions(predicate: (ActionInfo[ActionData]) ⇒ Boolean): Seq[ActionInfo[ActionData]]

    Processes actions whose predicate yields true.

    Processes actions whose predicate yields true.

    predicate

    The predicate to use when looking for actions based on their information (true indicates processing action)

    returns

    The collection of action info for successfully-completed actions

  25. def processActionsWithId(actionId: ActionId): Option[Seq[ActionInfo[ActionData]]]

    Processes the actions under a collection with the specified id.

    Processes the actions under a collection with the specified id.

    actionId

    The id of the collection of actions to process

    returns

    Some collection of action info for successfully-completed actions if the collection with the id exists, otherwise None

  26. def processAllActions(): Seq[ActionInfo[ActionData]]

    Processes all actions.

    Processes all actions.

    returns

    The collection of action info for successfully-completed actions

  27. def removePendingActions(predicate: (ActionInfo[ActionData]) ⇒ Boolean): Seq[ActionInfo[ActionData]]

    Removes any actions using the provided predicate.

    Removes any actions using the provided predicate.

    predicate

    The predicate to use when looking for actions to remove based on their information (true indicates removal)

    returns

    The collection of removed actions by their info

  28. def removePendingActionsWithId(actionId: ActionId): Option[Seq[ActionInfo[ActionData]]]

    Removes a collection of actions by the specified id.

    Removes a collection of actions by the specified id.

    actionId

    The id of the collection of actions to remove

    returns

    Some collection of actions if the id exists, otherwise None

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped