Android APIs
public final class

CircularArray

extends Object
java.lang.Object
   ↳ android.support.v4.util.CircularArray<E>

Class Overview

CircularArray is a generic circular array data structure that provides O(1) random read, O(1) prepend and O(1) append. The CircularArray automatically grows its capacity when number of added items is over its capacity.

Summary

Public Constructors
CircularArray()
Create a CircularArray with default capacity.
CircularArray(int minCapacity)
Create a CircularArray with capacity for at least minCapacity elements.
Public Methods
void addFirst(E e)
Add an element in front of the CircularArray.
void addLast(E e)
Add an element at end of the CircularArray.
void clear()
Remove all elements from the CircularArray.
E get(int n)
Get nth (0 <= n <= size()-1) element of the CircularArray.
E getFirst()
Get first element of the CircularArray.
E getLast()
Get last element of the CircularArray.
boolean isEmpty()
Return true if size() is 0.
E popFirst()
Remove first element from front of the CircularArray and return it.
E popLast()
Remove last element from end of the CircularArray and return it.
void removeFromEnd(int numOfElements)
Remove multiple elements from end of the CircularArray, ignore when numOfElements is less than or equals to 0.
void removeFromStart(int numOfElements)
Remove multiple elements from front of the CircularArray, ignore when numOfElements is less than or equals to 0.
int size()
Get number of elements in the CircularArray.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CircularArray ()

Create a CircularArray with default capacity.

public CircularArray (int minCapacity)

Create a CircularArray with capacity for at least minCapacity elements.

Parameters
minCapacity The minimum capacity required for the CircularArray.

Public Methods

public void addFirst (E e)

Add an element in front of the CircularArray.

Parameters
e Element to add.

public void addLast (E e)

Add an element at end of the CircularArray.

Parameters
e Element to add.

public void clear ()

Remove all elements from the CircularArray.

public E get (int n)

Get nth (0 <= n <= size()-1) element of the CircularArray.

Parameters
n The zero based element index in the CircularArray.
Returns
E The nth element.
Throws
ArrayIndexOutOfBoundsException} if n < 0 or n >= size().

public E getFirst ()

Get first element of the CircularArray.

Returns
E The first element.
Throws
ArrayIndexOutOfBoundsException} if CircularArray is empty.

public E getLast ()

Get last element of the CircularArray.

Returns
E The last element.
Throws
ArrayIndexOutOfBoundsException} if CircularArray is empty.

public boolean isEmpty ()

Return true if size() is 0.

Returns
boolean true if size() is 0.

public E popFirst ()

Remove first element from front of the CircularArray and return it.

Returns
E The element removed.
Throws
ArrayIndexOutOfBoundsException if CircularArray is empty.

public E popLast ()

Remove last element from end of the CircularArray and return it.

Returns
E The element removed.
Throws
ArrayIndexOutOfBoundsException if CircularArray is empty.

public void removeFromEnd (int numOfElements)

Remove multiple elements from end of the CircularArray, ignore when numOfElements is less than or equals to 0.

Parameters
numOfElements Number of elements to remove.
Throws
ArrayIndexOutOfBoundsException if numOfElements is larger than size()

public void removeFromStart (int numOfElements)

Remove multiple elements from front of the CircularArray, ignore when numOfElements is less than or equals to 0.

Parameters
numOfElements Number of elements to remove.
Throws
ArrayIndexOutOfBoundsException if numOfElements is larger than size()

public int size ()

Get number of elements in the CircularArray.

Returns
int Number of elements in the CircularArray.