org.perfcake.message.sequence

Class AbstractSequence

java.lang.Object

org.perfcake.message.sequence.AbstractSequence

All Implemented Interfaces:

Sequence

public abstract class AbstractSequence
extends Object
implements Sequence

This abstract sequence helps with pre-calculating the next value in the row in a background thread if the computation of the value is complex. None of the built-in sequences actually do not use this class. However, any extension might benefit from it.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
AbstractSequence()

Method Summary

Modifier and Type	Method and Description
abstract String	doGetNext()
abstract void	doReset()
void	publishNext(String sequenceId, Properties values) Asks the sequence to publish its next value(s) to the provided map.
void	reset() Resets the sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSequence

public AbstractSequence()

Method Detail

publishNext

public final void publishNext(String sequenceId,
                              Properties values)

Description copied from interface: Sequence

Asks the sequence to publish its next value(s) to the provided map. The map can be considered thread safe.

Specified by:

publishNext in interface Sequence

Parameters:

sequenceId - Id of the sequence instance.

values - The properties to provide the next value(s) to.

reset

public final void reset()
                 throws PerfCakeException

Description copied from interface: Sequence

Resets the sequence. This method is called at the very beginning, so it can be used to perform any initialization steps as well.

Specified by:

reset in interface Sequence

Throws:

PerfCakeException - When it was not possible to initialize the sequence to its original state.

doGetNext

public abstract String doGetNext()

doReset

public abstract void doReset()
                      throws PerfCakeException

Throws:

PerfCakeException