DefaultEventStudio (eventstudio 2.0.0 API)

java.lang.Object
- org.pdfsam.eventstudio.DefaultEventStudio

All Implemented Interfaces:

EventStudio
```
public class DefaultEventStudio
extends Object
implements EventStudio
```
Default implementation of EventStudio. It doesn't enforce a Singleton pattern and it's up to the user to decide how to use it and how many EventStudio the application needs. A singleton implementation with lazy initialization is provided with StaticStudio where the typical usage is:
```
 
 import static org.eventstudio.StaticStudio.eventStudio;
 
 public class Foo{
     void doSomethingAndNotify(){
        .....
        eventStudio.broadcast(new ImFinished(), "station");
     } 
 }
 
 
```
Hidden Station: The hidden station is a pre-built station with "hidden.station" name that is used to hide the station abstraction. Helper method are provided by DefaultEventStudio where the station name parameter is missing from the parameters list and the HIDDEN_STATION is used, providing a more traditional event bus pub/sub pattern.
Author:

Andrea Vacondio

Field Summary

Fields
Modifier and Type Field and Description

static String HIDDEN_STATION
A reserved station name that is used to hide the station abstraction.
- Fields inherited from interface org.pdfsam.eventstudio.EventStudio
  MAX_QUEUE_SIZE_PROP

Fields
Modifier and Type	Field and Description
`static String`	`HIDDEN_STATION` A reserved station name that is used to hide the station abstraction.

Constructor Summary

Constructors
Constructor and Description

DefaultEventStudio()

Constructors
Constructor and Description
`DefaultEventStudio()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`add(Class<T> eventClass, Listener<T> listener)` Adds a `Listener` to the hidden station listening for the given event class, hiding the station abstraction.
`<T> void`	`add(Class<T> eventClass, Listener<T> listener, int priority, ReferenceStrength strength)` Adds a `Listener` (with the given priority and strength ) to the hidden station listening for the given event class, hiding the station abstraction.
`<T> void`	`add(Class<T> eventClass, Listener<T> listener, String station)` Adds the given `Listener`, listening for the given event class, to the given station using default priority(0) ad default strength `ReferenceStrength.STRONG`.
`<T> void`	`add(Class<T> eventClass, Listener<T> listener, String station, int priority, ReferenceStrength strength)` Adds the given `Listener`, listening for the given event class, to the given station using the given priority (low values mean higher priority) and strength.
`<T> void`	`add(Listener<T> listener)` Adds a `Listener` to the hidden station, hiding the station abstraction.
`<T> void`	`add(Listener<T> listener, int priority, ReferenceStrength strength)` Adds a `Listener` (with the given priority and strength ) to the hidden station, hiding the station abstraction.
`<T> void`	`add(Listener<T> listener, String station)` Adds the given `Listener` to the given station using default priority(0) ad default strength `ReferenceStrength.STRONG`.
`<T> void`	`add(Listener<T> listener, String station, int priority, ReferenceStrength strength)` Adds the given `Listener` to the given station using the given priority (low values mean higher priority) and strength.
`void`	`addAnnotatedListeners(Object bean)` Discovers annotated method on the the given bean and adds them as `Listener`s
`void`	`broadcast(Object event)` Boradcast the event to the hidden station
`void`	`broadcast(Object event, String station)` Broadcasts the given event to the given station.
`void`	`broadcastToEveryStation(Object event)` Broadcasts the given event to every station.
`void`	`clear()` Clears the hidden station
`void`	`clear(String station)` Clear the given station removing the whole station from the `EventStudio` which means that `Listener`s and `Supervisor` will not be notified anymore.
`<T> boolean`	`remove(Class<T> eventClass, Listener<T> listener)` Removes the given listener listening on the given event, from the hidden station, hiding the station abstraction.
`<T> boolean`	`remove(Class<T> eventClass, Listener<T> listener, String station)` Removes the first occurrence of the given `Listener` listening for the given event, from the given station
`<T> boolean`	`remove(Listener<T> listener)` Removes the given listener from the hidden station, hiding the station abstraction.
`<T> boolean`	`remove(Listener<T> listener, String station)` Removes the first occurrence of the given `Listener` from the given station.
`void`	`supervisor(Supervisor supervisor)` Adds a `Supervisor` to the hidden station, hiding the station abstraction.
`void`	`supervisor(Supervisor supervisor, String station)` Sets a `Supervisor` for the given station.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HIDDEN_STATION
```
public static final String HIDDEN_STATION
```
    A reserved station name that is used to hide the station abstraction. Using the provided helper methods the station concept remains totally hidden and EventStudio can be used as a more traditional Event Bus with pub/sub pattern.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultEventStudio
```
public DefaultEventStudio()
```
- Method Detail
  - add
```
public <T> void add(Listener<T> listener,
                    String station,
                    int priority,
                    ReferenceStrength strength)
```
    Description copied from interface: EventStudio
    
    Adds the given Listener to the given station using the given priority (low values mean higher priority) and strength.
    
    Specified by:
    
    add in interface EventStudio
  - add
```
public <T> void add(Listener<T> listener,
                    String station)
```
    Description copied from interface: EventStudio
    
    Adds the given Listener to the given station using default priority(0) ad default strength ReferenceStrength.STRONG.
    
    Specified by:
    
    add in interface EventStudio
  - add
```
public <T> void add(Class<T> eventClass,
                    Listener<T> listener,
                    String station)
```
    Description copied from interface: EventStudio
    
    Adds the given Listener, listening for the given event class, to the given station using default priority(0) ad default strength ReferenceStrength.STRONG. This add method is useful when a listener can listen for a hierarchy of events.
    
    Specified by:
    
    add in interface EventStudio
    
    See Also:
    
    EventStudio.add(Class, Listener, String, int, ReferenceStrength)
  - add
```
public <T> void add(Class<T> eventClass,
                    Listener<T> listener,
                    String station,
                    int priority,
                    ReferenceStrength strength)
```
    Description copied from interface: EventStudio
    Adds the given Listener, listening for the given event class, to the given station using the given priority (low values mean higher priority) and strength. This add method is useful when a listener can listen for a hierarchy of events:
```
 
 class BroadListener{@code <T extends ParentEvent> implements Listener<T>} { 
     void onEvent(ParentEvent e){
           LOG.debug(e);
     }
 }
 
 class X {
   public void init() {
     EventStudio studio = ....
     studio.add(ChildEvent.class, new BroadListener{@code <ChildEvent>}(), "mystation");
     studio.add(AnotherChildEvent.class, new BroadListener{@code <AnotherChildEvent>()}, "mystation");
     ...
   }
 }
 
 
 
```
    Specified by:
    
    add in interface EventStudio
  - addAnnotatedListeners
```
public void addAnnotatedListeners(Object bean)
```
    Description copied from interface: EventStudio
    
    Discovers annotated method on the the given bean and adds them as Listeners
    
    Specified by:
    
    addAnnotatedListeners in interface EventStudio
    
    See Also:
    
    EventListener, EventStation
  - add
```
public <T> void add(Class<T> eventClass,
                    Listener<T> listener,
                    int priority,
                    ReferenceStrength strength)
```
    Adds a Listener (with the given priority and strength ) to the hidden station listening for the given event class, hiding the station abstraction.
    
    See Also:
    
    EventStudio.add(Listener, String, int, ReferenceStrength), HIDDEN_STATION
  - add
```
public <T> void add(Listener<T> listener,
                    int priority,
                    ReferenceStrength strength)
```
    Adds a Listener (with the given priority and strength ) to the hidden station, hiding the station abstraction.
    
    See Also:
    
    EventStudio.add(Listener, String, int, ReferenceStrength), HIDDEN_STATION
  - add
```
public <T> void add(Listener<T> listener)
```
    Adds a Listener to the hidden station, hiding the station abstraction.
    
    See Also:
    
    EventStudio.add(Listener, String), HIDDEN_STATION
  - add
```
public <T> void add(Class<T> eventClass,
                    Listener<T> listener)
```
    Adds a Listener to the hidden station listening for the given event class, hiding the station abstraction.
    
    See Also:
    
    EventStudio.add(Class, Listener, String), HIDDEN_STATION
  - supervisor
```
public void supervisor(Supervisor supervisor)
```
    Adds a Supervisor to the hidden station, hiding the station abstraction.
    
    Parameters:
    
    supervisor -
    
    See Also:
    
    EventStudio.supervisor(Supervisor, String), HIDDEN_STATION
  - supervisor
```
public void supervisor(Supervisor supervisor,
                       String station)
```
    Description copied from interface: EventStudio
    
    Sets a Supervisor for the given station. It will be notified of every event broadcasted to the station prior its delivery to the proper Listeners allowing event inspection.
    Supervisors cannot be removed but they can be replaces. See Supervisor.SLACKER
    
    Specified by:
    
    supervisor in interface EventStudio
  - remove
```
public <T> boolean remove(Listener<T> listener,
                          String station)
```
    Description copied from interface: EventStudio
    
    Removes the first occurrence of the given Listener from the given station.
    
    Specified by:
    
    remove in interface EventStudio
    
    Returns:
    
    true if the listener was successfully removed
  - remove
```
public <T> boolean remove(Class<T> eventClass,
                          Listener<T> listener,
                          String station)
```
    Description copied from interface: EventStudio
    
    Removes the first occurrence of the given Listener listening for the given event, from the given station
    
    Specified by:
    
    remove in interface EventStudio
    
    Returns:
    
    true if the listener was successfully removed
  - remove
```
public <T> boolean remove(Listener<T> listener)
```
    Removes the given listener from the hidden station, hiding the station abstraction.
    
    Returns:
    
    true if the listener was found and removed
    
    See Also:
    
    EventStudio.remove(Listener, String), HIDDEN_STATION
  - remove
```
public <T> boolean remove(Class<T> eventClass,
                          Listener<T> listener)
```
    Removes the given listener listening on the given event, from the hidden station, hiding the station abstraction.
    
    Returns:
    
    true if the listener was found and removed
    
    See Also:
    
    EventStudio.remove(Listener, String), HIDDEN_STATION
  - clear
```
public void clear(String station)
```
    Description copied from interface: EventStudio
    
    Clear the given station removing the whole station from the EventStudio which means that Listeners and Supervisor will not be notified anymore. A station with the same name can be recreated.
    
    Specified by:
    
    clear in interface EventStudio
  - clear
```
public void clear()
```
    Clears the hidden station
    
    See Also:
    
    EventStudio.clear(String), HIDDEN_STATION
  - broadcast
```
public void broadcast(Object event,
                      String station)
```
    Description copied from interface: EventStudio
    
    Broadcasts the given event to the given station. Listeners listening the given station and bound to the event class will be notified.
    
    Specified by:
    
    broadcast in interface EventStudio
  - broadcast
```
public void broadcast(Object event)
```
    Boradcast the event to the hidden station
    
    See Also:
    
    EventStudio.broadcast(Object, String), HIDDEN_STATION
  - broadcastToEveryStation
```
public void broadcastToEveryStation(Object event)
```
    Description copied from interface: EventStudio
    
    Broadcasts the given event to every station. Listeners bound to the event class (no matter the station they are listening) will be notified.
    
    Specified by:
    
    broadcastToEveryStation in interface EventStudio

Class DefaultEventStudio

Field Summary

Fields inherited from interface org.pdfsam.eventstudio.EventStudio

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HIDDEN_STATION

Constructor Detail

DefaultEventStudio

Method Detail

add

add

add

add

addAnnotatedListeners

add

add

add

add

supervisor

supervisor

remove

remove

remove

remove

clear

clear

broadcast

broadcast

broadcastToEveryStation