java.lang.Object
- org.apache.lucene.util.IntBlockPool

public final class IntBlockPool
extends java.lang.Object

A pool for int blocks similar to ByteBlockPool

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`IntBlockPool.Allocator`	Abstract class for allocating and freeing int blocks.
`static class`	`IntBlockPool.DirectAllocator`	A simple `IntBlockPool.Allocator` that never recycles.
`static class`	`IntBlockPool.SliceReader`	A `IntBlockPool.SliceReader` that can read int slices written by a `IntBlockPool.SliceWriter`
`static class`	`IntBlockPool.SliceWriter`	A `IntBlockPool.SliceWriter` that allows to write multiple integer slices into a given `IntBlockPool`.

Field Summary

Fields
Modifier and Type	Field	Description
`private IntBlockPool.Allocator`	`allocator`
`int[]`	`buffer`	Current head buffer
`int[][]`	`buffers`	array of buffers currently used in the pool.
`private int`	`bufferUpto`	index into the buffers array pointing to the current buffer used as the head
`private static int`	`FIRST_LEVEL_SIZE`	The first level size for new slices
`static int`	`INT_BLOCK_MASK`
`static int`	`INT_BLOCK_SHIFT`
`static int`	`INT_BLOCK_SIZE`
`int`	`intOffset`	Current head offset
`int`	`intUpto`	Pointer to the current position in head buffer
`private static int[]`	`LEVEL_SIZE_ARRAY`	An array holding the level sizes for int slices.
`private static int[]`	`NEXT_LEVEL_ARRAY`	An array holding the offset into the `LEVEL_SIZE_ARRAY` to quickly navigate to the next slice level.

Constructor Summary

Constructors
Constructor	Description
`IntBlockPool()`	Creates a new `IntBlockPool` with a default `IntBlockPool.Allocator`.
`IntBlockPool(IntBlockPool.Allocator allocator)`	Creates a new `IntBlockPool` with the given `IntBlockPool.Allocator`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private int`	`allocSlice(int[] slice, int sliceOffset)`	Allocates a new slice from the given offset
`private static boolean`	`assertSliceBuffer(int[] buffer)`
`private int`	`newSlice(int size)`	Creates a new int slice with the given starting size and returns the slices offset in the pool.
`void`	`nextBuffer()`	Advances the pool to its next buffer.
`void`	`reset()`	Resets the pool to its initial state reusing the first buffer.
`void`	`reset(boolean zeroFillBuffers, boolean reuseFirst)`	Expert: Resets the pool to its initial state reusing the first buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INT_BLOCK_SHIFT
```
public static final int INT_BLOCK_SHIFT
```
    See Also:
    
    Constant Field Values
  - INT_BLOCK_SIZE
```
public static final int INT_BLOCK_SIZE
```
    See Also:
    
    Constant Field Values
  - INT_BLOCK_MASK
```
public static final int INT_BLOCK_MASK
```
    See Also:
    
    Constant Field Values
  - buffers
```
public int[][] buffers
```
    array of buffers currently used in the pool. Buffers are allocated if needed don't modify this outside of this class
  - bufferUpto
```
private int bufferUpto
```
    index into the buffers array pointing to the current buffer used as the head
  - intUpto
```
public int intUpto
```
    Pointer to the current position in head buffer
  - buffer
```
public int[] buffer
```
    Current head buffer
  - intOffset
```
public int intOffset
```
    Current head offset
  - allocator
```
private final IntBlockPool.Allocator allocator
```
  - NEXT_LEVEL_ARRAY
```
private static final int[] NEXT_LEVEL_ARRAY
```
    An array holding the offset into the LEVEL_SIZE_ARRAY to quickly navigate to the next slice level.
  - LEVEL_SIZE_ARRAY
```
private static final int[] LEVEL_SIZE_ARRAY
```
    An array holding the level sizes for int slices.
  - FIRST_LEVEL_SIZE
```
private static final int FIRST_LEVEL_SIZE
```
    The first level size for new slices
- Constructor Detail
  - IntBlockPool
```
public IntBlockPool()
```
    Creates a new IntBlockPool with a default IntBlockPool.Allocator.
    
    See Also:
    
    nextBuffer()
  - IntBlockPool
```
public IntBlockPool(IntBlockPool.Allocator allocator)
```
    Creates a new IntBlockPool with the given IntBlockPool.Allocator.
    
    See Also:
    
    nextBuffer()
- Method Detail
  - reset
```
public void reset()
```
    Resets the pool to its initial state reusing the first buffer. Calling nextBuffer() is not needed after reset.
  - reset
```
public void reset(boolean zeroFillBuffers,
                  boolean reuseFirst)
```
    Expert: Resets the pool to its initial state reusing the first buffer.
    
    Parameters:
    
    zeroFillBuffers - if true the buffers are filled with 0. This should be set to true if this pool is used with IntBlockPool.SliceWriter.
    
    reuseFirst - if true the first buffer will be reused and calling nextBuffer() is not needed after reset iff the block pool was used before ie. nextBuffer() was called before.
  - nextBuffer
```
public void nextBuffer()
```
    Advances the pool to its next buffer. This method should be called once after the constructor to initialize the pool. In contrast to the constructor a reset() call will advance the pool to its first buffer immediately.
  - newSlice
```
private int newSlice(int size)
```
    Creates a new int slice with the given starting size and returns the slices offset in the pool.
    
    See Also:
    
    IntBlockPool.SliceReader
  - assertSliceBuffer
```
private static boolean assertSliceBuffer(int[] buffer)
```
  - allocSlice
```
private int allocSlice(int[] slice,
                       int sliceOffset)
```
    Allocates a new slice from the given offset

Class IntBlockPool

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INT_BLOCK_SHIFT

INT_BLOCK_SIZE

INT_BLOCK_MASK

buffers

bufferUpto

intUpto

buffer

intOffset

allocator

NEXT_LEVEL_ARRAY

LEVEL_SIZE_ARRAY

FIRST_LEVEL_SIZE

Constructor Detail

IntBlockPool

IntBlockPool

Method Detail

reset

reset

nextBuffer

newSlice

assertSliceBuffer

allocSlice