org.refcodes.observer

Class EventMatcherSugar

java.lang.Object

org.refcodes.observer.EventMatcherSugar

public class EventMatcherSugar
extends Object

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

Constructor Summary

Constructors

Constructor and Description
EventMatcherSugar()

Method Summary

Modifier and Type	Method and Description
static <E extends MetaDataActionEvent<A,?>,A> EventMatcher<E>	actionEqualWith(A aAction) Factory method to create an "EQUAL WITH" matcher for the given action compared with the action stored in the EventMetaData.
static <E extends MetaDataEvent<?>> EventMatcher<E>	and(EventMatcher<E>... aEventMatchers) Factory method to create an "AND" matcher for the given matchers.
static <E extends MetaDataEvent<?>> EventMatcher<E>	groupEqualWith(String aGroup) Factory method to create an "EQUAL WITH" matcher for the given group compared with the group stored in the EventMetaData.
static <E extends MetaDataEvent<?>> EventMatcher<E>	isAssignableFrom(Class<?> aEventType) Factory method to create an event matcher by event type.
static <E extends MetaDataEvent<?>> EventMatcher<E>	nameEqualWith(String aName) Factory method to create an "EQUAL WITH" matcher for the given name compared with the name stored in the EventMetaData.
static <E extends MetaDataEvent<?>> EventMatcher<E>	or(EventMatcher<E>... aEventMatchers) Factory method to create an "OR" matcher for the given matchers.
static <E extends MetaDataEvent<?>,PT> EventMatcher<E>	publisherIsAssignableFrom(Class<? extends PT> aPublisherType) Factory method to create an event matcher by event publisher type.
static <E extends MetaDataEvent<?>> EventMatcher<E>	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

EventMatcherSugar

public EventMatcherSugar()

Method Detail

isAssignableFrom

public static <E extends MetaDataEvent<?>> EventMatcher<E> isAssignableFrom(Class<?> aEventType)

Factory method to create an event matcher by event type.

Type Parameters:

E - The type of the event to be matched

Parameters:

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

Returns:

An event matcher by event type.

publisherIsAssignableFrom

public static <E extends MetaDataEvent<?>,PT> EventMatcher<E> publisherIsAssignableFrom(Class<? extends PT> aPublisherType)

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

Type Parameters:

E - The type of the event to be matched

PT - The publisher descriptor type

Parameters:

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

Returns:

An event matcher by event type.

or

@SafeVarargs
public static <E extends MetaDataEvent<?>> EventMatcher<E> or(EventMatcher<E>... aEventMatchers)

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

Type Parameters:

E - The event type applied to the matcher

Parameters:

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

Returns:

An "OR" matcher.

and

@SafeVarargs
public static <E extends MetaDataEvent<?>> EventMatcher<E> and(EventMatcher<E>... aEventMatchers)

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

Type Parameters:

E - The event type applied to the matcher

Parameters:

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

Returns:

An "AND" matcher.

nameEqualWith

public static <E extends MetaDataEvent<?>> EventMatcher<E> nameEqualWith(String aName)

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

Type Parameters:

E - The event type applied to the matcher

Parameters:

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 <E extends MetaDataEvent<?>> EventMatcher<E> groupEqualWith(String aGroup)

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

Type Parameters:

E - The event type applied to the matcher

Parameters:

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.

universalIdEqualWith

public static <E extends MetaDataEvent<?>> EventMatcher<E> universalIdEqualWith(String aUniversalId)

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

Type Parameters:

E - The event type applied to the matcher

Parameters:

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 MetaDataActionEvent<A,?>,A> EventMatcher<E> 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:

E - The event type applied to the matcher.

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:

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.