Package org.refcodes.eventbus.ext.application

Class ApplicationMatcherSugar


  • public class ApplicationMatcherSugar
extends Object
    Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the ApplicationMatcher elements.

    • Constructor Detail

      • ApplicationMatcherSugar

        public ApplicationMatcherSugar​()

    • Method Detail

      • isAssignableFrom

        public static ApplicationMatcher 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 ApplicationEvent,PT> ApplicationMatcher publisherIsAssignableFrom​(Class<? extends PT> aPublisherType)
        Factory method to create an event matcher by event publisher type.
        Type Parameters:
        E - the element type
        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 ApplicationMatcher or​(ApplicationMatcher... 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 ApplicationMatcher and​(ApplicationMatcher... aEventMatchers)
        Factory method to create an "AND" matcher for the given matchers.
        Parameters:
        aEventMatchers - The matchers to be combined by an "AND".
        Returns:
        An "AND" matcher.

      • aliasEqualWith

        public static ApplicationMatcher aliasEqualWith​(String aAlias)
        Factory method to create an "EQUAL WITH" matcher for the given name compared with the name stored in the EventMetaData.
        Parameters:
        aAlias - The name to be compared with a GenericMetaDataEvent's EventMetaData's name property.
        Returns:
        An "EQUAL WITH" matcher regarding the GenericMetaDataEvent's name property.

      • groupEqualWith

        public static ApplicationMatcher groupEqualWith​(String aGroup)
        Factory method to create an "EQUAL WITH" matcher for the given group compared with the group stored in the EventMetaData.
        Parameters:
        aGroup - The group to be compared with a GenericMetaDataEvent's EventMetaData's group property.
        Returns:
        An "EQUAL WITH" matcher regarding the GenericMetaDataEvent's group property.

      • channelEqualWith

        public static ApplicationMatcher channelEqualWith​(String aChannel)
        Factory method to create an "EQUAL WITH" matcher for the given channel compared with the channel stored in the EventMetaData.
        Parameters:
        aChannel - The channel to be compared with a GenericMetaDataEvent's EventMetaData's channel property.
        Returns:
        An "EQUAL WITH" matcher regarding the GenericMetaDataEvent's channel property.

      • uidIdEqualWith

        public static ApplicationMatcher uidIdEqualWith​(String aUid)
        Factory method to create an "EQUAL WITH" matcher for the given UID compared with the UID stored in the EventMetaData.
        Parameters:
        aUid - The UID to be compared with a GenericMetaDataEvent's EventMetaData's UID property.
        Returns:
        An "EQUAL WITH" matcher regarding the GenericMetaDataEvent's UID property.

      • actionEqualWith

        public static <E extends ApplicationEvent,A> ApplicationMatcher 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 element type
        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 GenericMetaDataEvent's EventMetaData's action property.
        Returns:
        An "EQUAL WITH" matcher regarding the GenericActionEvent's action property.