org.refcodes.eventbus

Class EventBusMatcherSugar

java.lang.Object

org.refcodes.eventbus.EventBusMatcherSugar

public class EventBusMatcherSugar
extends Object

Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the EventBusMatcher elements.

Constructor Summary

Constructors

Constructor and Description
EventBusMatcherSugar()

Method Summary

Modifier and Type	Method and Description
static <E extends org.refcodes.observer.MetaDataEvent<?>,A> EventBusMatcher	actionEqualWith(A aAction) Factory method to create an "EQUAL WITH" matcher for the given action compared with the action stored in the EventMetaData.
static EventBusMatcher	and(EventBusMatcher... aEventMatchers) Factory method to create an "AND" matcher for the given matchers.
static EventBusMatcher	channelEqualWith(String aChannel) Factory method to create an "EQUAL WITH" matcher for the given channel compared with the channel stored in the EventMetaData.
static EventBusMatcher	groupEqualWith(String aGroup) Factory method to create an "EQUAL WITH" matcher for the given group compared with the group stored in the EventMetaData.
static EventBusMatcher	isAssignableFrom(Class<?> aEventType) Factory method to create an event matcher by event type.
static EventBusMatcher	nameEqualWith(String aName) Factory method to create an "EQUAL WITH" matcher for the given name compared with the name stored in the EventMetaData.
static EventBusMatcher	or(EventBusMatcher... aEventMatchers) Factory method to create an "OR" matcher for the given matchers.
static <E extends org.refcodes.observer.MetaDataEvent<?>,PT> EventBusMatcher	publisherIsAssignableFrom(Class<? extends PT> aPublisherType) Factory method to create an event matcher by event publisher type.
static EventBusMatcher	universalIdEqualWith(String aUniversalId) Factory method to create an "EQUAL WITH" matcher for the given UID compared with the UID stored in the EventMetaData.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBusMatcherSugar

public EventBusMatcherSugar()

Method Detail

isAssignableFrom

public static EventBusMatcher isAssignableFrom(Class<?> aEventType)

Factory method to create an event matcher by event type.

Parameters:

aEventType - The event type to be matched by this matcher.

Returns:

An event matcher by event type.

publisherIsAssignableFrom

public static <E extends org.refcodes.observer.MetaDataEvent<?>,PT> EventBusMatcher publisherIsAssignableFrom(Class<? extends PT> aPublisherType)

Factory method to create an event matcher by event publisher type.

Type Parameters:

PT - The publisher descriptor type

Parameters:

> - The type of the event to be matched

aPublisherType - The event publisher type to be matched by this matcher.

Returns:

An event matcher by event type.

or

@SafeVarargs
public static EventBusMatcher or(EventBusMatcher... aEventMatchers)

Factory method to create an "OR" matcher for the given matchers.

Parameters:

aEventMatchers - The matchers to be combined by an "OR".

Returns:

An "OR" matcher.

and

@SafeVarargs
public static EventBusMatcher and(EventBusMatcher... aEventMatchers)

Factory method to create an "AND" matcher for the given matchers.

Parameters:

> - The event type applied to the matcher

aEventMatchers - The matchers to be combined by an "AND".

Returns:

An "AND" matcher.

nameEqualWith

public static EventBusMatcher nameEqualWith(String aName)

Factory method to create an "EQUAL WITH" matcher for the given name compared with the name stored in the EventMetaData.

Parameters:

> - The event type applied to the matcher

aName - The name to be compared with a MetaDataEvent's EventMetaData's name property.

Returns:

An "EQUAL WITH" matcher regarding the MetaDataEvent's name property.

groupEqualWith

public static EventBusMatcher groupEqualWith(String aGroup)

Factory method to create an "EQUAL WITH" matcher for the given group compared with the group stored in the EventMetaData.

Parameters:

> - The event type applied to the matcher

aGroup - The group to be compared with a MetaDataEvent's EventMetaData's group property.

Returns:

An "EQUAL WITH" matcher regarding the MetaDataEvent's group property.

channelEqualWith

public static EventBusMatcher channelEqualWith(String aChannel)

Factory method to create an "EQUAL WITH" matcher for the given channel compared with the channel stored in the EventMetaData.

Parameters:

> - The event type applied to the matcher

aChannel - The channel to be compared with a MetaDataEvent's EventMetaData's channel property.

Returns:

An "EQUAL WITH" matcher regarding the MetaDataEvent's channel property.

universalIdEqualWith

public static EventBusMatcher universalIdEqualWith(String aUniversalId)

Factory method to create an "EQUAL WITH" matcher for the given UID compared with the UID stored in the EventMetaData.

Parameters:

> - The event type applied to the matcher

aUniversalId - The UID to be compared with a MetaDataEvent's EventMetaData's UID property.

Returns:

An "EQUAL WITH" matcher regarding the MetaDataEvent's UID property.

actionEqualWith

public static <E extends org.refcodes.observer.MetaDataEvent<?>,A> EventBusMatcher actionEqualWith(A aAction)

Factory method to create an "EQUAL WITH" matcher for the given action compared with the action stored in the EventMetaData.

Type Parameters:

A - The type of the action stored in the event. CAUTION: The drawback of not using generic generic type declaration on a class level is no granted type safety, the advantage is the ease of use: Sub-classes can be used out of the box.

Parameters:

> - The event type applied to the matcher.

aAction - The action to be compared with a MetaDataEvent's EventMetaData's action property.

Returns:

An "EQUAL WITH" matcher regarding the ActionEvent's action property.