EventBusSubscriptionDefinition (vertigo-commons 3.4.0 API)

java.lang.Object
- io.vertigo.core.node.definition.AbstractDefinition
- - io.vertigo.commons.eventbus.definitions.EventBusSubscriptionDefinition<E>

Type Parameters:

E - type of event

All Implemented Interfaces:

io.vertigo.core.node.definition.Definition
```
public final class EventBusSubscriptionDefinition<E extends Event>
extends io.vertigo.core.node.definition.AbstractDefinition
```
This defintion defines a subscripter in the eventbus pattern. A endpoint is : - a type of event - a way to consume the event.

Author:

pchretien

Field Summary

Fields
Modifier and Type Field Description

static String PREFIX
- Fields inherited from interface io.vertigo.core.node.definition.Definition
  REGEX_DEFINITION_NAME

Constructor Summary

Constructors
Constructor	Description
`EventBusSubscriptionDefinition(String name, Class<E> eventType, Consumer<E> eventListener)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Class<E>`	`getEventType()`
`Consumer<E>`	`getListener()`	Return the consumer of the event
`boolean`	`match(Event event)`	Return if an event matches the event type of the actual subscription

Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition
getLocalName, getName, toString

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

- Field Detail
  - PREFIX
```
public static final String PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EventBusSubscriptionDefinition
```
public EventBusSubscriptionDefinition(String name,
                                      Class<E> eventType,
                                      Consumer<E> eventListener)
```
    Constructor
    
    Parameters:
    
    name - the name (must be unique)
    
    eventType - the type of event subscribed
    
    eventListener - the consumer of the event (what will be done with it)
- Method Detail
  - match
```
public boolean match(Event event)
```
    Return if an event matches the event type of the actual subscription
    
    Parameters:
    
    event - the type of event to test
    
    Returns:
    
    true if it matches
  - getListener
```
public Consumer<E> getListener()
```
    Return the consumer of the event
    
    Returns:
    
    the consumer
  - getEventType
```
public Class<E> getEventType()
```