BaseAllocator (Arrow Memory 0.11.0 API)

java.lang.Object
- org.apache.arrow.memory.BaseAllocator

すべての実装されたインタフェース:

AutoCloseable, BufferAllocator

直系の既知のサブクラス:

RootAllocator
```
public abstract class BaseAllocator
extends Object
implements BufferAllocator
```

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

class BaseAllocator.Reservation

static class BaseAllocator.Verbosity

ネストされたクラス
修飾子とタイプ	クラスと説明
`class`	`BaseAllocator.Reservation`
`static class`	`BaseAllocator.Verbosity`

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static boolean`	`DEBUG`
`static String`	`DEBUG_ALLOCATOR`
`static int`	`DEBUG_LOG_LENGTH`
`protected org.apache.arrow.memory.Accountant`	`parent` The parent allocator
`protected long`	`reservation` The amount of memory reserved for this allocator.

コンストラクタのサマリー

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`BaseAllocator(BaseAllocator parentAllocator, AllocationListener listener, String name, long initReservation, long maxAllocation)` Initialize an allocator

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`assertOpen()` Asserts (using java assertions) that the provided allocator is currently open.
`ArrowBuf`	`buffer(int initialRequestSize)` Allocate a new or reused buffer of the provided size.
`ArrowBuf`	`buffer(int initialRequestSize, BufferManager manager)` Allocate a new or reused buffer of the provided size.
`void`	`close()` Close this Accountant.
`long`	`getAllocatedMemory()` Return the current amount of allocated memory that this Accountant is managing accounting for.
`ArrowByteBufAllocator`	`getAsByteBufAllocator()` Returns the allocator this allocator falls back to when it needs more memory.
`ArrowBuf`	`getEmpty()` Get a reference to the empty buffer associated with this allocator.
`long`	`getHeadroom()`
`long`	`getLimit()` Return the current limit of this Accountant.
`String`	`getName()` Return the name of this allocator.
`long`	`getPeakMemoryAllocation()` The peak memory allocated by this Accountant.
`static StringBuilder`	`indent(StringBuilder sb, int indent)`
`static boolean`	`isDebug()`
`boolean`	`isOverLimit()`
`BufferAllocator`	`newChildAllocator(String name, AllocationListener listener, long initReservation, long maxAllocation)` Create a new child allocator.
`BufferAllocator`	`newChildAllocator(String name, long initReservation, long maxAllocation)` Create a new child allocator.
`AllocationReservation`	`newReservation()` Create an allocation reservation.
`static int`	`nextPowerOfTwo(int val)` Rounds up the provided value to the nearest power of two.
`static long`	`nextPowerOfTwo(long val)` Rounds up the provided value to the nearest power of two.
`void`	`releaseBytes(long size)`
`void`	`setLimit(long newLimit)` Set the maximum amount of memory that can be allocated in the this Accountant before failing an allocation.
`String`	`toString()`
`String`	`toVerboseString()` Provide a verbose string of the current allocator state.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド org.apache.arrow.memory.BufferAllocator
getAllocatedMemory, getHeadroom, getLimit, getPeakMemoryAllocation, isOverLimit, setLimit

- フィールドの詳細
  - DEBUG_ALLOCATOR
```
public static final String DEBUG_ALLOCATOR
```
    関連項目:
    
    定数フィールド値
  - DEBUG_LOG_LENGTH
```
public static final int DEBUG_LOG_LENGTH
```
    関連項目:
    
    定数フィールド値
  - DEBUG
```
public static final boolean DEBUG
```
  - parent
```
protected final org.apache.arrow.memory.Accountant parent
```
    The parent allocator
  - reservation
```
protected final long reservation
```
    The amount of memory reserved for this allocator. Releases below this amount of memory will not be returned to the parent Accountant until this Accountant is closed.
- コンストラクタの詳細
  - BaseAllocator
```
protected BaseAllocator(BaseAllocator parentAllocator,
                        AllocationListener listener,
                        String name,
                        long initReservation,
                        long maxAllocation)
                 throws OutOfMemoryException
```
    Initialize an allocator
    
    パラメータ:
    
    parentAllocator - parent allocator. null if defining a root allocator
    
    listener - listener callback. Must be non-null -- use AllocationListener.NOOP if no listener desired
    
    name - name of this allocator
    
    initReservation - initial reservation. Cannot be modified after construction
    
    maxAllocation - limit. Allocations past the limit fail. Can be modified after construction
    
    例外:
    
    OutOfMemoryException
- メソッドの詳細
  - nextPowerOfTwo
```
public static int nextPowerOfTwo(int val)
```
    Rounds up the provided value to the nearest power of two.
    
    パラメータ:
    
    val - An integer value.
    
    戻り値:
    
    The closest power of two of that value.
  - nextPowerOfTwo
```
public static long nextPowerOfTwo(long val)
```
    Rounds up the provided value to the nearest power of two.
    
    パラメータ:
    
    val - A long value.
    
    戻り値:
    
    The closest power of two of that value.
  - indent
```
public static StringBuilder indent(StringBuilder sb,
                                   int indent)
```
  - isDebug
```
public static boolean isDebug()
```
  - assertOpen
```
public void assertOpen()
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Asserts (using java assertions) that the provided allocator is currently open. If assertions are disabled, this is a no-op.
    
    定義:
    
    assertOpen インタフェース内 BufferAllocator
  - getName
```
public String getName()
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Return the name of this allocator. This is a human readable name that can help debugging. Typically provides coordinates about where this allocator was created
    
    定義:
    
    getName インタフェース内 BufferAllocator
    
    戻り値:
    
    the name of the allocator
  - getEmpty
```
public ArrowBuf getEmpty()
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Get a reference to the empty buffer associated with this allocator. Empty buffers are special because we don't worry about them leaking or managing reference counts on them since they don't actually point to any memory.
    
    定義:
    
    getEmpty インタフェース内 BufferAllocator
    
    戻り値:
    
    the empty buffer
  - buffer
```
public ArrowBuf buffer(int initialRequestSize)
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Allocate a new or reused buffer of the provided size. Note that the buffer may technically be larger than the requested size for rounding purposes. However, the buffer's capacity will be set to the configured size.
    
    定義:
    
    buffer インタフェース内 BufferAllocator
    
    パラメータ:
    
    initialRequestSize - The size in bytes.
    
    戻り値:
    
    a new ArrowBuf, or null if the request can't be satisfied
  - buffer
```
public ArrowBuf buffer(int initialRequestSize,
                       BufferManager manager)
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Allocate a new or reused buffer of the provided size. Note that the buffer may technically be larger than the requested size for rounding purposes. However, the buffer's capacity will be set to the configured size.
    
    定義:
    
    buffer インタフェース内 BufferAllocator
    
    パラメータ:
    
    initialRequestSize - The size in bytes.
    
    manager - A buffer manager to manage reallocation.
    
    戻り値:
    
    a new ArrowBuf, or null if the request can't be satisfied
  - getAsByteBufAllocator
```
public ArrowByteBufAllocator getAsByteBufAllocator()
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Returns the allocator this allocator falls back to when it needs more memory.
    
    定義:
    
    getAsByteBufAllocator インタフェース内 BufferAllocator
    
    戻り値:
    
    the underlying allocator used by this allocator
  - newChildAllocator
```
public BufferAllocator newChildAllocator(String name,
                                         long initReservation,
                                         long maxAllocation)
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Create a new child allocator.
    
    定義:
    
    newChildAllocator インタフェース内 BufferAllocator
    
    パラメータ:
    
    name - the name of the allocator.
    
    initReservation - the initial space reservation (obtained from this allocator)
    
    maxAllocation - maximum amount of space the new allocator can allocate
    
    戻り値:
    
    the new allocator, or null if it can't be created
  - newChildAllocator
```
public BufferAllocator newChildAllocator(String name,
                                         AllocationListener listener,
                                         long initReservation,
                                         long maxAllocation)
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Create a new child allocator.
    
    定義:
    
    newChildAllocator インタフェース内 BufferAllocator
    
    パラメータ:
    
    name - the name of the allocator.
    
    listener - allocation listener for the newly created child
    
    initReservation - the initial space reservation (obtained from this allocator)
    
    maxAllocation - maximum amount of space the new allocator can allocate
    
    戻り値:
    
    the new allocator, or null if it can't be created
  - newReservation
```
public AllocationReservation newReservation()
```
    インタフェースからコピーされた説明: BufferAllocator
    
    Create an allocation reservation. A reservation is a way of building up a request for a buffer whose size is not known in advance. See
    
    定義:
    
    newReservation インタフェース内 BufferAllocator
    
    戻り値:
    
    the newly created reservation
    
    関連項目:
    
    AllocationReservation
  - close
```
public void close()
```
    Close this Accountant. This will release any reservation bytes back to a parent Accountant.
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    定義:
    
    close インタフェース内 BufferAllocator
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - toVerboseString
```
public String toVerboseString()
```
    Provide a verbose string of the current allocator state. Includes the state of all child allocators, along with historical logs of each object and including stacktraces.
    
    定義:
    
    toVerboseString インタフェース内 BufferAllocator
    
    戻り値:
    
    A Verbose string of current allocator state.
  - releaseBytes
```
public void releaseBytes(long size)
```
  - isOverLimit
```
public boolean isOverLimit()
```
  - getLimit
```
public long getLimit()
```
    Return the current limit of this Accountant.
    
    戻り値:
    
    Limit in bytes.
  - setLimit
```
public void setLimit(long newLimit)
```
    Set the maximum amount of memory that can be allocated in the this Accountant before failing an allocation.
    
    パラメータ:
    
    newLimit - The limit in bytes.
  - getAllocatedMemory
```
public long getAllocatedMemory()
```
    Return the current amount of allocated memory that this Accountant is managing accounting for. Note this does not include reservation memory that hasn't been allocated.
    
    戻り値:
    
    Currently allocate memory in bytes.
  - getPeakMemoryAllocation
```
public long getPeakMemoryAllocation()
```
    The peak memory allocated by this Accountant.
    
    戻り値:
    
    The peak allocated memory in bytes.
  - getHeadroom
```
public long getHeadroom()
```

クラス BaseAllocator

ネストされたクラスのサマリー

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド org.apache.arrow.memory.BufferAllocator

フィールドの詳細

DEBUG_ALLOCATOR

DEBUG_LOG_LENGTH

DEBUG

parent

reservation

コンストラクタの詳細

BaseAllocator

メソッドの詳細

nextPowerOfTwo

nextPowerOfTwo

indent

isDebug

assertOpen

getName

getEmpty

buffer

buffer

getAsByteBufAllocator

newChildAllocator

newChildAllocator

newReservation

close

toString

toVerboseString

releaseBytes

isOverLimit

getLimit

setLimit

getAllocatedMemory

getPeakMemoryAllocation

getHeadroom