CircularBuffer (libGDX AI)

java.lang.Object
- com.badlogic.gdx.ai.utils.CircularBuffer<T>

public class CircularBuffer<T>
extends java.lang.Object

A circular buffer, possibly resizable.

Constructor Summary

Constructors
Constructor and Description
`CircularBuffer()` Creates a resizable `CircularBuffer`.
`CircularBuffer(int initialCapacity)` Creates a resizable `CircularBuffer` with the given initial capacity.
`CircularBuffer(int initialCapacity, boolean resizable)` Creates a `CircularBuffer` with the given initial capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all items from this circular buffer.
`void`	`ensureCapacity(int additionalCapacity)` Increases the size of the backing array (if necessary) to accommodate the specified number of additional items.
`boolean`	`isEmpty()` Returns `true` if this circular buffer is empty; `false` otherwise.
`boolean`	`isFull()` Returns `true` if this circular buffer contains as many items as its capacity; `false` otherwise.
`boolean`	`isResizable()` Returns `true` if this circular buffer can be resized; `false` otherwise.
`T`	`read()` Removes and returns the item at the head of this circular buffer (if any).
`protected void`	`resize(int newCapacity)` Creates a new backing array with the specified capacity containing the current items.
`void`	`setResizable(boolean resizable)` Sets the flag specifying whether this circular buffer can be resized or not.
`int`	`size()` Returns the number of elements in this circular buffer.
`boolean`	`store(T item)` Adds the given item to the tail of this circular buffer.

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

- Constructor Detail
  - CircularBuffer
```
public CircularBuffer()
```
    Creates a resizable CircularBuffer.
  - CircularBuffer
```
public CircularBuffer(int initialCapacity)
```
    Creates a resizable CircularBuffer with the given initial capacity.
    
    Parameters:
    
    initialCapacity - the initial capacity of this circular buffer
  - CircularBuffer
```
public CircularBuffer(int initialCapacity,
                      boolean resizable)
```
    Creates a CircularBuffer with the given initial capacity.
    
    Parameters:
    
    initialCapacity - the initial capacity of this circular buffer
    
    resizable - whether this buffer is resizable or has fixed capacity
- Method Detail
  - store
```
public boolean store(T item)
```
    Adds the given item to the tail of this circular buffer.
    
    Parameters:
    
    item - the item to add
    
    Returns:
    
    true if the item has been successfully added to this circular buffer; false otherwise.
  - read
```
public T read()
```
    Removes and returns the item at the head of this circular buffer (if any).
    
    Returns:
    
    the item just removed or null if this circular buffer is empty.
  - clear
```
public void clear()
```
    Removes all items from this circular buffer.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this circular buffer is empty; false otherwise.
  - isFull
```
public boolean isFull()
```
    Returns true if this circular buffer contains as many items as its capacity; false otherwise.
  - size
```
public int size()
```
    Returns the number of elements in this circular buffer.
  - isResizable
```
public boolean isResizable()
```
    Returns true if this circular buffer can be resized; false otherwise.
  - setResizable
```
public void setResizable(boolean resizable)
```
    Sets the flag specifying whether this circular buffer can be resized or not.
    
    Parameters:
    
    resizable - the flag
  - ensureCapacity
```
public void ensureCapacity(int additionalCapacity)
```
    Increases the size of the backing array (if necessary) to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.
    
    Parameters:
    
    additionalCapacity - the number of additional items
  - resize
```
protected void resize(int newCapacity)
```
    Creates a new backing array with the specified capacity containing the current items.
    
    Parameters:
    
    newCapacity - the new capacity

Class CircularBuffer<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CircularBuffer

CircularBuffer

CircularBuffer

Method Detail

store

read

clear

isEmpty

isFull

size

isResizable

setResizable

ensureCapacity

resize