org.perfcake.message.sequence

Class NumberSequence

java.lang.Object

org.perfcake.message.sequence.NumberSequence

All Implemented Interfaces:

Sequence

public class NumberSequence
extends Object
implements Sequence

Simple sequence of numbers. Can go in both directions, can specify boundaries and a step.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
NumberSequence()

Method Summary

Modifier and Type	Method and Description
long	getEnd() Gets the last value in the sequence.
long	getStart() Gets the beginning of the sequence.
long	getStep() Gets the step size.
boolean	isCycle() Determines whether the sequence cycles around (starts from the beginning after reaching the last value).
void	publishNext(String sequenceId, Properties values) Asks the sequence to publish its next value(s) to the provided map.
void	reset() Resets the sequence.
NumberSequence	setCycle(boolean cycle) Specifies whether the sequence cycles around (starts from the beginning after reaching the last value).
NumberSequence	setEnd(long end) Sets the last value in the sequence.
NumberSequence	setStart(long start) Sets the beginning of the sequence.
NumberSequence	setStep(long step) Sets the step size.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberSequence

public NumberSequence()

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 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.

getStart

public long getStart()

Gets the beginning of the sequence.

Returns:

The beginning of the sequence.

setStart

public NumberSequence setStart(long start)

Sets the beginning of the sequence.

Parameters:

start - The beginning of the sequence.

Returns:

Instance of this to support fluent API.

getEnd

public long getEnd()

Gets the last value in the sequence.

Returns:

The last value in the sequence.

setEnd

public NumberSequence setEnd(long end)

Sets the last value in the sequence. Set to Long.MIN_VALUE in case of positive steps (or to Long.MAX_VALUE in case of negative steps) to disable check of the last value in the interval.

Parameters:

end - The last value in the sequence.

Returns:

Instance of this to support fluent API.

getStep

public long getStep()

Gets the step size.

Returns:

The step size.

setStep

public NumberSequence setStep(long step)

Sets the step size. If the check for the last value of the interval is disabled, this configuration is preserved even for step with negative numbers.

Parameters:

step - The step size.

Returns:

Instance of this to support fluent API.

isCycle

public boolean isCycle()

Determines whether the sequence cycles around (starts from the beginning after reaching the last value).

Returns:

True if and only if the sequence cycles around.

setCycle

public NumberSequence setCycle(boolean cycle)

Specifies whether the sequence cycles around (starts from the beginning after reaching the last value).

Parameters:

cycle - True to allow the sequence to cycle around.

Returns:

Instance of this to support fluent API.