com.github.pnavais.machine.model

Class AbstractFilteredState

java.lang.Object

com.github.pnavais.machine.api.AbstractNode

com.github.pnavais.machine.model.State

com.github.pnavais.machine.model.AbstractWrappedState

com.github.pnavais.machine.model.AbstractFilteredState

All Implemented Interfaces:

MessageFilter<State,StateContext>, Mergeable<AbstractNode>, Node

Direct Known Subclasses:

FilteredState

public abstract class AbstractFilteredState
extends AbstractWrappedState
implements MessageFilter<State,StateContext>

Base class for all Message filter state decorators

Nested Class Summary

Nested classes/interfaces inherited from class com.github.pnavais.machine.model.State

State.StateBuilder

Field Summary

Fields inherited from class com.github.pnavais.machine.model.AbstractWrappedState

state

Fields inherited from class com.github.pnavais.machine.api.AbstractNode

id, name

Constructor Summary

Constructors

Constructor and Description
AbstractFilteredState(@NonNull State state) Constructor with the state to wrap

Method Summary

Modifier and Type	Method and Description
abstract MessageFilter<State,StateContext>	getMessageFilter() Retrieves the message filter
Status	onDispatch(StateContext context) Intercepts a message to be dispatched to the given destination.
Status	onReceive(StateContext context) Intercepts a message to be received from the given origin.
abstract void	setDispatchHandler(Function<StateContext,Status> dispatchHandler) Sets the dispatch handler for ANY message
abstract void	setDispatchHandler(Message message, Function<StateContext,Status> dispatchHandler) Sets the dispatch handler for the given message
abstract void	setReceptionHandler(Function<StateContext,Status> receptionHandler) Sets the reception handler for ANY message
abstract void	setReceptionHandler(Message message, Function<StateContext,Status> receptionHandler) Sets the reception handler for the given message

Methods inherited from class com.github.pnavais.machine.model.AbstractWrappedState

equals, getName, hashCode, isFinal, setFinal

Methods inherited from class com.github.pnavais.machine.model.State

addProperty, from, getProperty, hasProperties, hasProperty, merge, named, removeProperty, toString

Methods inherited from class com.github.pnavais.machine.api.AbstractNode

getId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractFilteredState

public AbstractFilteredState(@NonNull
                             @NonNull State state)

Constructor with the state to wrap

Parameters:

state - the state to wrap

Method Detail

getMessageFilter

public abstract MessageFilter<State,StateContext> getMessageFilter()

Retrieves the message filter

Returns:

the message filter

setReceptionHandler

public abstract void setReceptionHandler(Function<StateContext,Status> receptionHandler)

Sets the reception handler for ANY message

Parameters:

receptionHandler - the reception handler

setReceptionHandler

public abstract void setReceptionHandler(Message message,
                                         Function<StateContext,Status> receptionHandler)

Sets the reception handler for the given message

Parameters:

message - the message

receptionHandler - the reception handler

setDispatchHandler

public abstract void setDispatchHandler(Function<StateContext,Status> dispatchHandler)

Sets the dispatch handler for ANY message

Parameters:

dispatchHandler - the dispatch handler

setDispatchHandler

public abstract void setDispatchHandler(Message message,
                                        Function<StateContext,Status> dispatchHandler)

Sets the dispatch handler for the given message

Parameters:

message - the message

dispatchHandler - the dispatch handler

onDispatch

public Status onDispatch(StateContext context)

Intercepts a message to be dispatched to the given destination.

Specified by:

onDispatch in interface MessageFilter<State,StateContext>

Parameters:

context - the context

Returns:

whether the operation shall continue or not

onReceive

public Status onReceive(StateContext context)

Intercepts a message to be received from the given origin.

Specified by:

onReceive in interface MessageFilter<State,StateContext>

Parameters:

context - the context

Returns:

whether the operation shall continue or not