com.github.pnavais.machine.model

Class FilteredState

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

com.github.pnavais.machine.model.FilteredState

All Implemented Interfaces:

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

public class FilteredState
extends AbstractFilteredState

A decorator adding message filtering functionality to regular states.

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
FilteredState(@NonNull State state) Constructor with state

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static FilteredState	from(@NonNull State state) Static factory method to decorate the state with message filtering capabilities
int	hashCode()
AbstractNode	merge(AbstractNode state) Adds the filter mappings from the given state to the current instance.
void	setDispatchHandler(Function<StateContext,Status> dispatchHandler) Sets the dispatch handler for ANY message
void	setDispatchHandler(Message message, Function<StateContext,Status> dispatchHandler) Sets the dispatch handler for the given message
void	setReceptionHandler(Function<StateContext,Status> receptionHandler) Sets the reception handler for ANY message
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.AbstractFilteredState

getMessageFilter, onDispatch, onReceive

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

getName, isFinal, setFinal

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

addProperty, from, getProperty, hasProperties, hasProperty, 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

FilteredState

public FilteredState(@NonNull
                     @NonNull State state)

Constructor with state

Parameters:

state - the state

Method Detail

from

public static FilteredState from(@NonNull
                                 @NonNull State state)

Static factory method to decorate the state with message filtering capabilities

Parameters:

state - the state to wrap

Returns:

the filtered state

setReceptionHandler

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

Sets the reception handler for ANY message

Specified by:

setReceptionHandler in class AbstractFilteredState

Parameters:

receptionHandler - the reception handler

setReceptionHandler

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

Sets the reception handler for the given message

Specified by:

setReceptionHandler in class AbstractFilteredState

Parameters:

receptionHandler - the reception handler

message - the message

setDispatchHandler

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

Sets the dispatch handler for ANY message

Specified by:

setDispatchHandler in class AbstractFilteredState

Parameters:

dispatchHandler - the dispatch handler

setDispatchHandler

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

Sets the dispatch handler for the given message

Specified by:

setDispatchHandler in class AbstractFilteredState

Parameters:

dispatchHandler - the dispatch handler

message - the message

merge

public AbstractNode merge(AbstractNode state)

Adds the filter mappings from the given state to the current instance.

Specified by:

merge in interface Mergeable<AbstractNode>

Overrides:

merge in class State

Parameters:

state - the state to merge

Returns:

the merged state

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractWrappedState

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractWrappedState