org.axonframework.eventhandling

Class MultiSourceTrackingToken

java.lang.Object

org.axonframework.eventhandling.MultiSourceTrackingToken

All Implemented Interfaces:

Serializable, TrackingToken

public class MultiSourceTrackingToken
extends Object
implements TrackingToken, Serializable

A TrackingToken implementation combining several TrackingTokens into one. Used to keep track of several message sources at once, like the MultiStreamableMessageSource.

Since:

4.2

Author:

Greg Woods

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiSourceTrackingToken(Map<String,TrackingToken> trackingTokens) Construct a new MultiSourceTrackingToken from a map of existing tokens.

Method Summary

Modifier and Type	Method and Description
MultiSourceTrackingToken	advancedTo(String streamName, TrackingToken newTokenForStream) Advances a single token within the tokenMap
boolean	covers(TrackingToken other) Compares this token to other checking each member token with its counterpart to see if they are covered in the other token.
boolean	equals(Object o)
TrackingToken	getTokenForStream(String streamName) Return the tracking token for an individual stream
Map<String,TrackingToken>	getTrackingTokens() Returns the map containing the constituent tokens.
int	hashCode()
TrackingToken	lowerBound(TrackingToken other) Compares this token to other by comparing each member token with its counterpart in the other token.
OptionalLong	position() Returns the sum of all positions of the constituent tracking tokens.
String	toString()
TrackingToken	upperBound(TrackingToken other) Compares this token to other by comparing each member token with its counterpart in the other token.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiSourceTrackingToken

@ConstructorProperties(value="trackingTokens")
public MultiSourceTrackingToken(Map<String,TrackingToken> trackingTokens)

Construct a new MultiSourceTrackingToken from a map of existing tokens.

Parameters:

trackingTokens - the map of tokens which make up the MultiSourceTrackingToken

Method Detail

lowerBound

public TrackingToken lowerBound(TrackingToken other)

Compares this token to other by comparing each member token with its counterpart in the other token. If the two tokens contain different number of constituent tokens, or have the same number but different names, then these two MultiSourceTrackingTokens must be tracking different MultiStreamableMessageSources.

Specified by:

lowerBound in interface TrackingToken

Parameters:

other - The token to compare to this one

Returns:

token representing the lower bound of both tokens

upperBound

public TrackingToken upperBound(TrackingToken other)

Compares this token to other by comparing each member token with its counterpart in the other token. If the two tokens contain different number of constituent tokens, or have the same number but different names, then these two MultiSourceTrackingTokens must be tracking different MultiStreamableMessageSources.

Specified by:

upperBound in interface TrackingToken

Parameters:

other - The token to compare this token to

Returns:

a token that represents the furthest position of this or the other streams

covers

public boolean covers(TrackingToken other)

Compares this token to other checking each member token with its counterpart to see if they are covered in the other token. If the two tokens contain different number of constituent tokens, or have the same number but different names, then these two MultiSourceTrackingTokens must be tracking different MultiStreamableMessageSources.

Specified by:

covers in interface TrackingToken

Parameters:

other - The token to compare to this one

Returns:

true if this token covers the other, otherwise false

advancedTo

public MultiSourceTrackingToken advancedTo(String streamName,
                                           TrackingToken newTokenForStream)

Advances a single token within the tokenMap

Parameters:

streamName - the stream/source which is being advanced

newTokenForStream - the token representing the new position of the stream

Returns:

the token representing the current processing position of all streams.

getTokenForStream

public TrackingToken getTokenForStream(String streamName)

Return the tracking token for an individual stream

Parameters:

streamName - the name of the stream for the tracking token

Returns:

the tracking token for the stream

getTrackingTokens

public Map<String,TrackingToken> getTrackingTokens()

Returns the map containing the constituent tokens.

Returns:

the map containing the constituent tokens.

position

public OptionalLong position()

Returns the sum of all positions of the constituent tracking tokens.

Specified by:

position in interface TrackingToken

Returns:

Sum of all positions of the constituent tracking tokens.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object