CircularArray - Android SDK

Summary: Ctors | Methods | Inherited Methods | [Expand All]

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

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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

The nth element.

Throws

	ArrayIndexOutOfBoundsException} if n < 0 or n >= size().

public E getFirst ()

Get first element of the CircularArray.

Returns

The first element.

Throws

	ArrayIndexOutOfBoundsException} if CircularArray is empty.

public E getLast ()

Get last element of the CircularArray.

Returns

The last element.

Throws

	ArrayIndexOutOfBoundsException} if CircularArray is empty.

public boolean isEmpty ()

Return true if size() is 0.

Returns

true if size() is 0.

public E popFirst ()

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

Returns

The element removed.

Throws

ArrayIndexOutOfBoundsException	if CircularArray is empty.

public E popLast ()

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

Returns

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

Number of elements in the CircularArray.

Results

Interfaces

Classes

CircularArray

Class Overview

Summary

Public Constructors

public CircularArray ()

public CircularArray (int minCapacity)

Parameters

Public Methods

public void addFirst (E e)

Parameters

public void addLast (E e)

Parameters

public void clear ()

public E get (int n)

Parameters

Returns

Throws

public E getFirst ()

Returns

Throws

public E getLast ()

Returns

Throws

public boolean isEmpty ()

Returns

public E popFirst ()

Returns

Throws

public E popLast ()

Returns

Throws

public void removeFromEnd (int numOfElements)

Parameters

Throws

public void removeFromStart (int numOfElements)

Parameters

Throws

public int size ()

Returns