com.github.pnavais.machine.api.filter

Class FunctionMessageFilter<T extends AbstractNode,C extends Context<T>>

java.lang.Object

com.github.pnavais.machine.api.filter.FunctionMessageFilter<T,C>

Type Parameters:

T - the type of the nodes handling messages

All Implemented Interfaces:

MessageFilter<T,C>

public class FunctionMessageFilter<T extends AbstractNode,C extends Context<T>>
extends Object
implements MessageFilter<T,C>

Allows fine grained customization of the filtering as it provides a per message functionality injection.

Constructor Summary

Constructors

Constructor and Description
FunctionMessageFilter() Creates a new FunctionMessageFilter

Method Summary

Modifier and Type	Method and Description
Function<C,Status>	getDispatchHandler(@NonNull Message message) Retrieves the dispatch handler for the given message
Function<C,Status>	getReceptionHandler(@NonNull Message message) Retrieves the reception handler for the given message
Status	onDispatch(C context) Delegates the execution of the message dispatch to the dispatch function registered with the message.
Status	onReceive(C context) Delegates the execution of the message processing to the reception function registered with the message.
void	removeDispatchHandler(@NonNull Message message) Removes the dispatch handler for the given message.
void	removeReceptionHandler(@NonNull Message message) Removes the reception handler for the given message.
void	setDispatchHandler(@NonNull Message message, @NonNull Function<C,Status> function) Sets the given function to handle the message to be dispatched.
void	setReceptionHandler(@NonNull Message message, @NonNull Function<C,Status> function) Sets the given function to handle the message to be received.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionMessageFilter

public FunctionMessageFilter()

Creates a new FunctionMessageFilter

Method Detail

setDispatchHandler

public void setDispatchHandler(@NonNull
                               @NonNull Message message,
                               @NonNull
                               @NonNull Function<C,Status> function)

Sets the given function to handle the message to be dispatched.

Parameters:

message - the message to be dispatched

function - the function to handle dispatch messages

setReceptionHandler

public void setReceptionHandler(@NonNull
                                @NonNull Message message,
                                @NonNull
                                @NonNull Function<C,Status> function)

Sets the given function to handle the message to be received.

Parameters:

message - the message to be received

function - the function to handle received messages

getDispatchHandler

public Function<C,Status> getDispatchHandler(@NonNull
                                             @NonNull Message message)

Retrieves the dispatch handler for the given message

Parameters:

message - the message

Returns:

the dispatch handler

getReceptionHandler

public Function<C,Status> getReceptionHandler(@NonNull
                                              @NonNull Message message)

Retrieves the reception handler for the given message

Parameters:

message - the message

Returns:

the reception handler

removeReceptionHandler

public void removeReceptionHandler(@NonNull
                                   @NonNull Message message)

Removes the reception handler for the given message.

Parameters:

message - the message

removeDispatchHandler

public void removeDispatchHandler(@NonNull
                                  @NonNull Message message)

Removes the dispatch handler for the given message.

Parameters:

message - the message

onDispatch

public Status onDispatch(C context)

Delegates the execution of the message dispatch to the dispatch function registered with the message.

Specified by:

onDispatch in interface MessageFilter<T extends AbstractNode,C extends Context<T>>

Parameters:

context - the context

Returns:

the status of the operation

onReceive

public Status onReceive(C context)

Delegates the execution of the message processing to the reception function registered with the message.

Specified by:

onReceive in interface MessageFilter<T extends AbstractNode,C extends Context<T>>

Parameters:

context - the context

Returns:

the status of the operation