com.carrotsearch.hppcrt

Class IteratorPool<OBJECT_TYPE,ITERATOR_TYPE extends AbstractIterator<OBJECT_TYPE>>

java.lang.Object

com.carrotsearch.hppcrt.ObjectPool<ITERATOR_TYPE>

com.carrotsearch.hppcrt.IteratorPool<OBJECT_TYPE,ITERATOR_TYPE>

Type Parameters:

ITERATOR_TYPE -

OBJECT_TYPE -

public class IteratorPool<OBJECT_TYPE,ITERATOR_TYPE extends AbstractIterator<OBJECT_TYPE>>
extends ObjectPool<ITERATOR_TYPE>

This class represents a specialized ObjectPool of Iterators of type ITERATOR_TYPE, which are AbstractIterators for OBJECT_TYPE objects. All Iterator pools have the same allocation scheme :

 - Initial size is given either by global configureInitialPoolSize(int) call,
   by system property "HPPC_ITERATOR_POOLSIZE",
   or by default, the number of processors.
 - Grows by chunks of initial size,
 - When its size gets bigger than MAX_SIZE_GROWTH_FACTOR * initial size,
   capacity remains constant while 'initial size'  old objects are disposed of.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SIZE_GROWTH_FACTOR An Iterator pool never get bigger than MAX_SIZE_GROWTH_FACTOR times its original size.
static java.lang.String	POOL_INITIAL_SIZE_PROPERTY

Fields inherited from class com.carrotsearch.hppcrt.ObjectPool

arrayPool, capacity, currentSize, factory, growthPolicy

Constructor Summary

Constructors

Constructor and Description
IteratorPool(ObjectFactory<ITERATOR_TYPE> objFactory)

Method Summary

Modifier and Type	Method and Description
ITERATOR_TYPE	borrow() Customized borrow(), that properly attach the borrowed iterator to its corresponding pool and resets it to allow iteration as if the iterator was created for the first time.
static void	configureInitialPoolSize(int initialSize) Configure the initial pool size for all iterators, for all containers.
static int	getMaxPoolSize() Returns the expected max size all iterator pools will be limited to.

Methods inherited from class com.carrotsearch.hppcrt.ObjectPool

capacity, release, size

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SIZE_GROWTH_FACTOR

public static final int MAX_SIZE_GROWTH_FACTOR

An Iterator pool never get bigger than MAX_SIZE_GROWTH_FACTOR times its original size.

See Also:

Constant Field Values

POOL_INITIAL_SIZE_PROPERTY

public static final java.lang.String POOL_INITIAL_SIZE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

IteratorPool

public IteratorPool(ObjectFactory<ITERATOR_TYPE> objFactory)

Method Detail

borrow

public ITERATOR_TYPE borrow()

Customized borrow(), that properly attach the borrowed iterator to its corresponding pool and resets it to allow iteration as if the iterator was created for the first time.

Overrides:

borrow in class ObjectPool<ITERATOR_TYPE extends AbstractIterator<OBJECT_TYPE>>

configureInitialPoolSize

public static final void configureInitialPoolSize(int initialSize)

Configure the initial pool size for all iterators, for all containers. This is primarily destined to be used at application startup. However, calling it at runtime on new and existing containers results a smooth capacity adaptation.

Parameters:

initialSize -

getMaxPoolSize

public static final int getMaxPoolSize()

Returns the expected max size all iterator pools will be limited to.