org.perfcake.message.sequence

Interface Sequence

All Known Implementing Classes:

AbstractSequence, FileLinesSequence, FilesContentSequence, NumberSequence, PrimitiveNumberSequence, RandomSequence, RandomUuidSequence, ThreadIdSequence, TimeStampSequence

public interface Sequence

Represents an automatically generated sequence of values. The resulting values can be used in the message body.

Author:

Martin Večeřa

Method Summary

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

Method Detail

publishNext

void publishNext(String sequenceId,
                 Properties values)

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

Parameters:

sequenceId - Id of the sequence instance.

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

reset

default void reset()
            throws PerfCakeException

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

Throws:

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