net.cpollet.jixture.fixtures.generator.field

Class DateSequence

java.lang.Object

net.cpollet.jixture.fixtures.generator.field.BaseFieldGenerator<Date>

net.cpollet.jixture.fixtures.generator.field.DateSequence

All Implemented Interfaces:

Iterator<Date>, FieldGenerator<Date>

public class DateSequence
extends BaseFieldGenerator<Date>

Generates a sequence of Date.

Requires

• Joda Time

Author:

Christophe Pollet

Constructor Summary

Constructors

Constructor and Description
DateSequence(org.joda.time.DateTime start, org.joda.time.DateTime stop) Build a sequence that will return values between start and end (inclusive) with an increment of 1 day.
DateSequence(org.joda.time.DateTime start, org.joda.time.DateTime stop, org.joda.time.ReadableDuration duration) Build a sequence that will return values between start and end (inclusive) with an increment of increment.
DateSequence(org.joda.time.DateTime start, org.joda.time.DateTime stop, org.joda.time.ReadablePeriod period) Build a sequence that will return values between start and end (inclusive) with an increment of increment.

Method Summary

Methods

Modifier and Type	Method and Description
Date	current() Returns the current sequence value.
boolean	hasNext() Returns true if the generator has more value to generate (In other words, returns true if next would return a value rather than throwing an exception.)
Date	next() Returns the next generated value.
void	reset() Resets the DateSequence.
String	toString()

Methods inherited from class net.cpollet.jixture.fixtures.generator.field.BaseFieldGenerator

remove

Methods inherited from class java.lang.Object

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

Constructor Detail

DateSequence

public DateSequence(org.joda.time.DateTime start,
            org.joda.time.DateTime stop)

Build a sequence that will return values between start and end (inclusive) with an increment of 1 day.

Parameters:

start - first value in sequence, inclusive.

stop - last element in sequence, inclusive.

See Also:

DateSequence(org.joda.time.DateTime, org.joda.time.DateTime, org.joda.time.ReadablePeriod)

DateSequence

public DateSequence(org.joda.time.DateTime start,
            org.joda.time.DateTime stop,
            org.joda.time.ReadableDuration duration)

Build a sequence that will return values between start and end (inclusive) with an increment of increment. For instance, in:

     s1 = new DateSequence(
        new DateTime(1, 1, 1, 0, 0, 0),
        new DateTime(1, 1, 3, 0, 0, 0),
        new Duration(24 * 60 * 60 * 1000)
     );
     s1 = new DateSequence(
        new DateTime(1, 1, 1, 0, 0, 0),
        new DateTime(1, 1, 5, 0, 0, 0),
        new Duration(2 * 24 * 60 * 60 * 1000)
     );
 

s1 will generate the following dates: 1-1-1T0:0:0, 1-1-2T0:0:0, 1-1-3T0:0:0 and s2 will generate 1-1-1T0:0:0, 1-1-3T0:0:0, 1-1-5T0:0:0.

Parameters:

start - first value in sequence, inclusive.

stop - last element in sequence, inclusive.

duration - increment.

Throws:

IllegalArgumentException - if start is less than stop or if increment is less than or equal to 0ms.

DateSequence

public DateSequence(org.joda.time.DateTime start,
            org.joda.time.DateTime stop,
            org.joda.time.ReadablePeriod period)

Build a sequence that will return values between start and end (inclusive) with an increment of increment. For instance, in:

     s1 = new DateSequence(
        new DateTime(1, 1, 1, 0, 0, 0),
        new DateTime(1, 1, 3, 0, 0, 0),
        new Period.days(1)
     );
     s1 = new DateSequence(
        new DateTime(1, 1, 1, 0, 0, 0),
        new DateTime(1, 1, 5, 0, 0, 0),
        new Period.days(1)
     );
 

s1 will generate the following dates: 1-1-1T0:0:0, 1-1-2T0:0:0, 1-1-3T0:0:0 and s2 will generate 1-1-1T0:0:0, 1-1-3T0:0:0, 1-1-5T0:0:0.

Parameters:

start - first value in sequence, inclusive.

stop - last element in sequence, inclusive.

period - increment.

Throws:

IllegalArgumentException - if start is less than stop or if increment is less than or equal to 0ms.

Method Detail

reset

public void reset()

Resets the DateSequence. After this method is called, the following next or current call returns the first generated value.

current

public Date current()

Returns the current sequence value. Implicitly calls next if next was never called before since creation of last reset().

Returns:

the current sequence value

hasNext

public boolean hasNext()

Returns true if the generator has more value to generate (In other words, returns true if next would return a value rather than throwing an exception.)

Returns:

true if the iteration has more value.

next

public Date next()

Returns the next generated value.

Returns:

the next generated value.

Throws:

NoSuchElementException - if the iteration has no more value.

toString

public String toString()

Overrides:

toString in class Object