com.neurosys.q.notification.events

Class BasicTokenEvent<T extends Token<T>>

java.lang.Object

com.neurosys.domain.ModelObject

com.neurosys.domain.Status

com.neurosys.q.notification.events.BasicTokenEvent<T>

All Implemented Interfaces:

Consumable, Behaviors, FlowStatusChange, SynchronousChange<Feedback>, MultipleTokenEvent<T>, SingleTokenEvent<T>, SupplierTokenEvent<T>, TokenEvent<T>, Serializable

Direct Known Subclasses:

MessageTokenEvent, NextTokenEvent

public class BasicTokenEvent<T extends Token<T>>
extends Status
implements SingleTokenEvent<T>, MultipleTokenEvent<T>, SupplierTokenEvent<T>

Event over any Token type.

Author:

Arjun Dhar

See Also:

AddOnBehavior, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.q.notification.events.TokenEvent

TokenEvent.ContainerEventType, TokenEvent.TokenEventFlowStatus, TokenEvent.TokenEventType

Field Summary

Fields inherited from class com.neurosys.domain.Status

level, message

Constructor Summary

Constructors

Constructor and Description
BasicTokenEvent()
BasicTokenEvent(BasicTokenEvent tokenEvent)
BasicTokenEvent(String json)
BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus)
BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus, Collection<T> tokens)
BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus, Supplier<Collection<T>> tokensSupplier)
BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus, T token)

Method Summary

Modifier and Type	Method and Description
void	addBehavior(Behavior behavior)
void	consumed() Set the state to consumed. Note there maybe other getters on the bean/state that can internally set this.
Map<Class,Behavior>	getBehaviors() Optional AddOnBehaviors for custom strategies
Feedback	getFeedback() Any SynchronousChange related Feedback
TokenEvent.TokenEventFlowStatus	getFlowStatus() The FlowStatus type of the event itself
Consumer	getPreEventProcess() When tokens are assigned to this Event, then pre-action on tokens before the event is processed.
T	getToken()
Collection<T>	getTokens()
void	setBehaviors(Map<Class,Behavior> behaviors) Optional AddOnBehaviors for custom strategies
void	setFeedback(Feedback feedback) Any SynchronousChange related Feedback
void	setFlowStatus(TokenEvent.TokenEventFlowStatus flowStatus) The FlowStatus type of the event itself
void	setToken(T token)
void	setTokens(Collection<T> tokens)
void	setTokens(Supplier<Collection<T>> tokensSupplier)
String	toString()
boolean	wasConsumed() Maintain state if token(s) were accessed or not.

Methods inherited from class com.neurosys.domain.Status

getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTokenEvent

public BasicTokenEvent()

BasicTokenEvent

public BasicTokenEvent(BasicTokenEvent tokenEvent)

BasicTokenEvent

public BasicTokenEvent(String json)

BasicTokenEvent

public BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus)

BasicTokenEvent

public BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus,
                       T token)

BasicTokenEvent

public BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus,
                       Collection<T> tokens)

BasicTokenEvent

public BasicTokenEvent(TokenEvent.TokenEventFlowStatus flowStatus,
                       Supplier<Collection<T>> tokensSupplier)

Method Detail

getToken

public T getToken()

Specified by:

getToken in interface SingleTokenEvent<T extends Token<T>>

setToken

public void setToken(T token)

Specified by:

setToken in interface SingleTokenEvent<T extends Token<T>>

getTokens

public Collection<T> getTokens()

Specified by:

getTokens in interface MultipleTokenEvent<T extends Token<T>>

Specified by:

getTokens in interface SupplierTokenEvent<T extends Token<T>>

Returns:

the tokens

Can be null:

false

setTokens

public void setTokens(Collection<T> tokens)

Parameters:

tokens - the tokens to set

setTokens

public void setTokens(Supplier<Collection<T>> tokensSupplier)

getFlowStatus

public TokenEvent.TokenEventFlowStatus getFlowStatus()

The FlowStatus type of the event itself

Specified by:

getFlowStatus in interface FlowStatusChange

Specified by:

getFlowStatus in interface TokenEvent<T extends Token<T>>

See Also:

TokenEventFlowStatus

Can be null:

false

setFlowStatus

public void setFlowStatus(TokenEvent.TokenEventFlowStatus flowStatus)

The FlowStatus type of the event itself

Specified by:

setFlowStatus in interface TokenEvent<T extends Token<T>>

See Also:

TokenEventFlowStatus

Can be null:

false

wasConsumed

public boolean wasConsumed()

Maintain state if token(s) were accessed or not. This is if an event is called multiple times to know if the event has already been consumed;

Specified by:

wasConsumed in interface Consumable

consumed

public void consumed()

Description copied from interface: Consumable

Set the state to consumed.
Note there maybe other getters on the bean/state that can internally set this.

Specified by:

consumed in interface Consumable

getFeedback

public Feedback getFeedback()

Any SynchronousChange related Feedback

Specified by:

getFeedback in interface SynchronousChange<Feedback>

Specified by:

getFeedback in interface TokenEvent<T extends Token<T>>

Can be null:

true

setFeedback

public void setFeedback(Feedback feedback)

Any SynchronousChange related Feedback

Specified by:

setFeedback in interface SynchronousChange<Feedback>

Can be null:

true

getPreEventProcess

public Consumer getPreEventProcess()

When tokens are assigned to this Event, then pre-action on tokens before the event is processed.

Typically it will act on tokens assigned to the event via a internal instance specific Consumer or Function.

Sample use case: Token is passed on but while creation tokens are not assigned. The token assignment and any other pre event processing callback can be called upon using this as a trigger.

By default this simply assigns the input to token.

Specified by:

getPreEventProcess in interface TokenEvent<T extends Token<T>>

getBehaviors

public Map<Class,Behavior> getBehaviors()

Optional AddOnBehaviors for custom strategies

Specified by:

getBehaviors in interface Behaviors

Specified by:

getBehaviors in interface TokenEvent<T extends Token<T>>

Can be null:

true

setBehaviors

public void setBehaviors(Map<Class,Behavior> behaviors)

Optional AddOnBehaviors for custom strategies

Specified by:

setBehaviors in interface Behaviors

Specified by:

setBehaviors in interface TokenEvent<T extends Token<T>>

Can be null:

true

addBehavior

public void addBehavior(Behavior behavior)

Specified by:

addBehavior in interface Behaviors

Specified by:

addBehavior in interface TokenEvent<T extends Token<T>>

See Also:

TokenEvent.getBehaviors()

toString

public String toString()

Overrides:

toString in class Object