org.apache.cayenne.event

## Class NoopEventManager

- java.lang.Object
- - org.apache.cayenne.event.NoopEventManager

- All Implemented Interfaces:
    EventManager

      public class NoopEventManager
      extends Object
      implements EventManager

  Since:
    4.0.2

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `NoopEventManager()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addListener(Object listener, String methodName, Class<?> eventParameterClass, EventSubject subject)` Register an `EventListener` for events sent by any sender.
    `void` | `addListener(Object listener, String methodName, Class<?> eventParameterClass, EventSubject subject, Object sender)` Register an `EventListener` for events sent by a specific sender.
    `void` | `addNonBlockingListener(Object listener, String methodName, Class<?> eventParameterClass, EventSubject subject)`
    `void` | `addNonBlockingListener(Object listener, String methodName, Class<?> eventParameterClass, EventSubject subject, Object sender)`
    `boolean` | `isSingleThreaded()` Returns true if this EventManager is single-threaded.
    `void` | `postEvent(EventObject event, EventSubject subject)` Sends an event to all registered objects about a particular subject.
    `void` | `postNonBlockingEvent(EventObject event, EventSubject subject)` Sends an event to all registered objects about a particular subject.
    `boolean` | `removeAllListeners(EventSubject subject)` Removes all listeners for a given subject.
    `boolean` | `removeListener(Object listener)` Unregister the specified listener from all event subjects handled by this manager instance.
    `boolean` | `removeListener(Object listener, EventSubject subject)` Unregister the specified listener for the events about the given subject.
    `boolean` | `removeListener(Object listener, EventSubject subject, Object sender)` Unregister the specified listener for the events about the given subject and the given sender.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### NoopEventManager

          public NoopEventManager()

  - ### Method Detail

    - #### isSingleThreaded

          public boolean isSingleThreaded()

      Description copied from interface: `EventManager`
      Returns true if this EventManager is single-threaded. If so it will throw an exception on any attempt to register an unblocking listener or dispatch a non-blocking event.
      Specified by:
        `isSingleThreaded` in interface `EventManager`

    - #### addListener

          public void addListener(Object listener,
                                  String methodName,
                                  Class<?> eventParameterClass,
                                  EventSubject subject)

      Description copied from interface: `EventManager`
      Register an `EventListener` for events sent by any sender.
      Specified by:
        `addListener` in interface `EventManager`

    - #### addNonBlockingListener

          public void addNonBlockingListener(Object listener,
                                             String methodName,
                                             Class<?> eventParameterClass,
                                             EventSubject subject)

      Specified by:
        `addNonBlockingListener` in interface `EventManager`

    - #### addListener

          public void addListener(Object listener,
                                  String methodName,
                                  Class<?> eventParameterClass,
                                  EventSubject subject,
                                  Object sender)

      Description copied from interface: `EventManager`
      Register an `EventListener` for events sent by a specific sender.
      Specified by:
        `addListener` in interface `EventManager`
      Parameters:
        `listener` - the object to be notified about events
        `methodName` - the name of the listener method to be invoked
        `eventParameterClass` - the class of the single event argument passed to `methodName`
        `subject` - the event subject that the listener is interested in
        `sender` - the object whose events the listener is interested in; `null` means 'any sender'.

    - #### addNonBlockingListener

          public void addNonBlockingListener(Object listener,
                                             String methodName,
                                             Class<?> eventParameterClass,
                                             EventSubject subject,
                                             Object sender)

      Specified by:
        `addNonBlockingListener` in interface `EventManager`

    - #### removeListener

          public boolean removeListener(Object listener)

      Description copied from interface: `EventManager`
      Unregister the specified listener from all event subjects handled by this manager instance.
      Specified by:
        `removeListener` in interface `EventManager`
      Parameters:
        `listener` - the object to be unregistered
      Returns:
        `true` if `listener` could be removed for any existing subjects, else returns `false`.

    - #### removeAllListeners

          public boolean removeAllListeners(EventSubject subject)

      Description copied from interface: `EventManager`
      Removes all listeners for a given subject.
      Specified by:
        `removeAllListeners` in interface `EventManager`

    - #### removeListener

          public boolean removeListener(Object listener,
                                        EventSubject subject)

      Description copied from interface: `EventManager`
      Unregister the specified listener for the events about the given subject.
      Specified by:
        `removeListener` in interface `EventManager`
      Parameters:
        `listener` - the object to be unregistered
        `subject` - the subject from which the listener is to be unregistered
      Returns:
        `true` if `listener` could be removed for the given subject, else returns `false`.

    - #### removeListener

          public boolean removeListener(Object listener,
                                        EventSubject subject,
                                        Object sender)

      Description copied from interface: `EventManager`
      Unregister the specified listener for the events about the given subject and the given sender.
      Specified by:
        `removeListener` in interface `EventManager`
      Parameters:
        `listener` - the object to be unregistered
        `subject` - the subject from which the listener is to be unregistered
        `sender` - the object whose events the listener was interested in; `null` means 'any sender'.
      Returns:
        `true` if `listener` could be removed for the given subject, else returns `false`.

    - #### postEvent

          public void postEvent(EventObject event,
                                EventSubject subject)

      Description copied from interface: `EventManager`
      Sends an event to all registered objects about a particular subject. Event is sent synchronously, so the sender thread is blocked until all the listeners finish processing the event.
      Specified by:
        `postEvent` in interface `EventManager`
      Parameters:
        `event` - the event to be posted to the observers
        `subject` - the subject about which observers will be notified

    - #### postNonBlockingEvent

          public void postNonBlockingEvent(EventObject event,
                                           EventSubject subject)

      Description copied from interface: `EventManager`
      Sends an event to all registered objects about a particular subject. Event is queued by EventManager, releasing the sender thread, and is later dispatched in a separate thread.
      Specified by:
        `postNonBlockingEvent` in interface `EventManager`
      Parameters:
        `event` - the event to be posted to the observers
        `subject` - the subject about which observers will be notified

Copyright © 2001–2023 Apache Cayenne. All rights reserved.