BigArrays (core 5.6.16 API)

java.lang.Object
- org.elasticsearch.common.util.BigArrays

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Releasable
```
public class BigArrays
extends java.lang.Object
implements Releasable
```
Utility class to work with arrays.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTE_PAGE_SIZE`
`static int`	`INT_PAGE_SIZE`
`static int`	`LONG_PAGE_SIZE`
`static BigArrays`	`NON_RECYCLING_INSTANCE`
`static int`	`OBJECT_PAGE_SIZE`
`static int`	`PAGE_SIZE_IN_BYTES` Page size in bytes: 16KB

Constructor Summary

Constructors
Constructor and Description
`BigArrays(PageCacheRecycler recycler, CircuitBreakerService breakerService, boolean checkBreaker)`
`BigArrays(Settings settings, CircuitBreakerService breakerService)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CircuitBreakerService`	`breakerService()`
`void`	`close()`
`boolean`	`equals(ByteArray array, ByteArray other)`
`ByteArray`	`grow(ByteArray array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`DoubleArray`	`grow(DoubleArray array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`FloatArray`	`grow(FloatArray array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`IntArray`	`grow(IntArray array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`LongArray`	`grow(LongArray array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`<T> ObjectArray<T>`	`grow(ObjectArray<T> array, long minSize)` Grow an array to a size that is larger than `minSize`, preserving content, and potentially reusing part of the provided array.
`int`	`hashCode(ByteArray array)`
`ByteArray`	`newByteArray(long size)` Allocate a new `ByteArray` initialized with zeros.
`ByteArray`	`newByteArray(long size, boolean clearOnResize)` Allocate a new `ByteArray`.
`DoubleArray`	`newDoubleArray(long size)` Allocate a new `DoubleArray` of the given capacity.
`DoubleArray`	`newDoubleArray(long size, boolean clearOnResize)` Allocate a new `DoubleArray`.
`FloatArray`	`newFloatArray(long size)` Allocate a new `FloatArray` of the given capacity.
`FloatArray`	`newFloatArray(long size, boolean clearOnResize)` Allocate a new `FloatArray`.
`IntArray`	`newIntArray(long size)` Allocate a new `IntArray`.
`IntArray`	`newIntArray(long size, boolean clearOnResize)` Allocate a new `IntArray`.
`LongArray`	`newLongArray(long size)` Allocate a new `LongArray`.
`LongArray`	`newLongArray(long size, boolean clearOnResize)` Allocate a new `LongArray`.
`<T> ObjectArray<T>`	`newObjectArray(long size)` Allocate a new `ObjectArray`.
`static long`	`overSize(long minTargetSize)` Returns the next size to grow when working with parallel arrays that may have different page sizes or number of bytes per element.
`static long`	`overSize(long minTargetSize, int pageSize, int bytesPerElement)` Return the next size to grow to that is >= `minTargetSize`.
`ByteArray`	`resize(ByteArray array, long size)` Resize the array to the exact provided size.
`DoubleArray`	`resize(DoubleArray array, long size)` Resize the array to the exact provided size.
`FloatArray`	`resize(FloatArray array, long size)` Resize the array to the exact provided size.
`IntArray`	`resize(IntArray array, long size)` Resize the array to the exact provided size.
`LongArray`	`resize(LongArray array, long size)` Resize the array to the exact provided size.
`<T> ObjectArray<T>`	`resize(ObjectArray<T> array, long size)` Resize the array to the exact provided size.
`BigArrays`	`withCircuitBreaking()` Return an instance of this BigArrays class with circuit breaking explicitly enabled, instead of only accounting enabled

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

- Field Detail
  - NON_RECYCLING_INSTANCE
```
public static final BigArrays NON_RECYCLING_INSTANCE
```
  - PAGE_SIZE_IN_BYTES
```
public static final int PAGE_SIZE_IN_BYTES
```
    Page size in bytes: 16KB
    
    See Also:
    
    Constant Field Values
  - BYTE_PAGE_SIZE
```
public static final int BYTE_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - INT_PAGE_SIZE
```
public static final int INT_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - LONG_PAGE_SIZE
```
public static final int LONG_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - OBJECT_PAGE_SIZE
```
public static final int OBJECT_PAGE_SIZE
```
- Constructor Detail
  - BigArrays
```
public BigArrays(Settings settings,
                 @Nullable
                 CircuitBreakerService breakerService)
```
  - BigArrays
```
public BigArrays(PageCacheRecycler recycler,
                 @Nullable
                 CircuitBreakerService breakerService,
                 boolean checkBreaker)
```
- Method Detail
  - overSize
```
public static long overSize(long minTargetSize)
```
    Returns the next size to grow when working with parallel arrays that may have different page sizes or number of bytes per element.
  - overSize
```
public static long overSize(long minTargetSize,
                            int pageSize,
                            int bytesPerElement)
```
    Return the next size to grow to that is >= minTargetSize. Inspired from ArrayUtil.oversize(int, int) and adapted to play nicely with paging.
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface Releasable
  - withCircuitBreaking
```
public BigArrays withCircuitBreaking()
```
    Return an instance of this BigArrays class with circuit breaking explicitly enabled, instead of only accounting enabled
  - breakerService
```
public CircuitBreakerService breakerService()
```
  - newByteArray
```
public ByteArray newByteArray(long size,
                              boolean clearOnResize)
```
    Allocate a new ByteArray.
    
    Parameters:
    
    size - the initial length of the array
    
    clearOnResize - whether values should be set to 0 on initialization and resize
  - newByteArray
```
public ByteArray newByteArray(long size)
```
    Allocate a new ByteArray initialized with zeros.
    
    Parameters:
    
    size - the initial length of the array
  - resize
```
public ByteArray resize(ByteArray array,
                        long size)
```
    Resize the array to the exact provided size.
  - grow
```
public ByteArray grow(ByteArray array,
                      long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.
  - hashCode
```
public int hashCode(ByteArray array)
```
    See Also:
    
    Arrays.hashCode(byte[])
  - equals
```
public boolean equals(ByteArray array,
                      ByteArray other)
```
    See Also:
    
    Arrays.equals(byte[], byte[])
  - newIntArray
```
public IntArray newIntArray(long size,
                            boolean clearOnResize)
```
    Allocate a new IntArray.
    
    Parameters:
    
    size - the initial length of the array
    
    clearOnResize - whether values should be set to 0 on initialization and resize
  - newIntArray
```
public IntArray newIntArray(long size)
```
    Allocate a new IntArray.
    
    Parameters:
    
    size - the initial length of the array
  - resize
```
public IntArray resize(IntArray array,
                       long size)
```
    Resize the array to the exact provided size.
  - grow
```
public IntArray grow(IntArray array,
                     long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.
  - newLongArray
```
public LongArray newLongArray(long size,
                              boolean clearOnResize)
```
    Allocate a new LongArray.
    
    Parameters:
    
    size - the initial length of the array
    
    clearOnResize - whether values should be set to 0 on initialization and resize
  - newLongArray
```
public LongArray newLongArray(long size)
```
    Allocate a new LongArray.
    
    Parameters:
    
    size - the initial length of the array
  - resize
```
public LongArray resize(LongArray array,
                        long size)
```
    Resize the array to the exact provided size.
  - grow
```
public LongArray grow(LongArray array,
                      long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.
  - newDoubleArray
```
public DoubleArray newDoubleArray(long size,
                                  boolean clearOnResize)
```
    Allocate a new DoubleArray.
    
    Parameters:
    
    size - the initial length of the array
    
    clearOnResize - whether values should be set to 0 on initialization and resize
  - newDoubleArray
```
public DoubleArray newDoubleArray(long size)
```
    Allocate a new DoubleArray of the given capacity.
  - resize
```
public DoubleArray resize(DoubleArray array,
                          long size)
```
    Resize the array to the exact provided size.
  - grow
```
public DoubleArray grow(DoubleArray array,
                        long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.
  - newFloatArray
```
public FloatArray newFloatArray(long size,
                                boolean clearOnResize)
```
    Allocate a new FloatArray.
    
    Parameters:
    
    size - the initial length of the array
    
    clearOnResize - whether values should be set to 0 on initialization and resize
  - newFloatArray
```
public FloatArray newFloatArray(long size)
```
    Allocate a new FloatArray of the given capacity.
  - resize
```
public FloatArray resize(FloatArray array,
                         long size)
```
    Resize the array to the exact provided size.
  - grow
```
public FloatArray grow(FloatArray array,
                       long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.
  - newObjectArray
```
public <T> ObjectArray<T> newObjectArray(long size)
```
    Allocate a new ObjectArray.
    
    Parameters:
    
    size - the initial length of the array
  - resize
```
public <T> ObjectArray<T> resize(ObjectArray<T> array,
                                 long size)
```
    Resize the array to the exact provided size.
  - grow
```
public <T> ObjectArray<T> grow(ObjectArray<T> array,
                               long minSize)
```
    Grow an array to a size that is larger than minSize, preserving content, and potentially reusing part of the provided array.

Class BigArrays

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NON_RECYCLING_INSTANCE

PAGE_SIZE_IN_BYTES

BYTE_PAGE_SIZE

INT_PAGE_SIZE

LONG_PAGE_SIZE

OBJECT_PAGE_SIZE

Constructor Detail

BigArrays

BigArrays

Method Detail

overSize

overSize

close

withCircuitBreaking

breakerService

newByteArray

newByteArray

resize

grow

hashCode

equals

newIntArray

newIntArray

resize

grow

newLongArray

newLongArray

resize

grow

newDoubleArray

newDoubleArray

resize

grow

newFloatArray

newFloatArray

resize

grow

newObjectArray

resize

grow