com.hazelcast.flakeidgen.impl

Class IdBatch

java.lang.Object

com.hazelcast.flakeidgen.impl.IdBatch

All Implemented Interfaces:

Iterable<Long>

public class IdBatch
extends Object
implements Iterable<Long>

Set of IDs returned from FlakeIdGenerator.

IDs can be iterated using a foreach loop:

    IdBatch idBatch = myFlakeIdGenerator.newIdBatch(100);
    for (Long id : idBatch) {
        // ... use the id
    }
 

Object is immutable.

Constructor Summary

Constructors

Constructor and Description
IdBatch(long base, long increment, int batchSize) Constructor

Method Summary

Modifier and Type	Method and Description
long	base() Returns the first ID in the set.
int	batchSize() Returns number of IDs in the set.
long	increment() Returns increment from base() for the next ID in the set.
Iterator<Long>	iterator() Returns iterator that will iterate contained IDs (boxing the as Long).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IdBatch

public IdBatch(long base,
               long increment,
               int batchSize)

Constructor

Parameters:

base - See base()

increment - See increment()

batchSize - See batchSize()

Method Detail

base

public long base()

Returns the first ID in the set.

increment

public long increment()

Returns increment from base() for the next ID in the set.

batchSize

public int batchSize()

Returns number of IDs in the set.

iterator

@Nonnull
public Iterator<Long> iterator()

Returns iterator that will iterate contained IDs (boxing the as Long). remove() is not supported.

Specified by:

iterator in interface Iterable<Long>