coldbox.system.core.events

Class EventPool

railo-context.Component
        extended by coldbox.system.core.events.EventPool
Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Direct Known Subclasses:
    InterceptorState

    This object models an event pool that fires by convetion on its configured name.

    Constructor Summary
    init(string state)
          constructor.
    Method Summary
    boolean exists(string key)
         Checks if the passed key is registered with this event pool.
    any getObject(string key)
         Get an object from this event pool.
    any getPool()
         Get the Pool linked hash map.
    any getState()
         Get the event pool's state name.
    private any invoker(any target, any interceptData)
         Execute an event interception point.
    any process(struct interceptData)
         Process this event pool according to it's name.
    any register(string key, any target)
         Register an object class with this event pool.
    void setState(any state)
         Set the event pool's state name.
    boolean unregister(string key)
         Unregister an object from this event pool.
     
    Methods inherited from class railo-context.Component
    None
    Constructor Detail

    init

    public init(string state)

    constructor

    Parameters:
    state - The event pool state name to model
    Method Detail

    exists

    public boolean exists(string key)

    Checks if the passed key is registered with this event pool

    Parameters:
    key - The key of the object

    getObject

    public any getObject(string key)

    Get an object from this event pool. Else return a blank structure if not found

    Parameters:
    key - The key of the object

    getPool

    public any getPool()

    Get the Pool linked hash map

    getState

    public any getState()

    Get the event pool's state name

    invoker

    private any invoker(any target, any interceptData)

    Execute an event interception point

    Parameters:
    target - The target object
    interceptData - A metadata structure used to pass intercepted information.

    process

    public any process(struct interceptData)

    Process this event pool according to it's name.

    Parameters:
    interceptData - A data structure used to pass information.

    register

    public any register(string key, any target)

    Register an object class with this event pool

    Parameters:
    key - The key of the object
    target - The target object to register.

    setState

    public void setState(any state)

    Set the event pool's state name

    Parameters:
    state

    unregister

    public boolean unregister(string key)

    Unregister an object from this event pool

    Parameters:
    key - The key of the object