Class CircularList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

jmt.framework.data.CircularList<E>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess, SequencedCollection<E>

public class CircularList<E>
extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, Serializable

Name: CircularList

Description: A random access circular list based on an array, optimized for speed in append and remove operations in the head or tail of the list. The array is able to grow when internal capacity is finished, with an O(n) complexity.
CircularQueue is optimized to have O(1) complexity on each get operation and in add and remove operations at the beginning and at the end of the list. Other operations are O(n). This implementation is good for unordered, unbounded LIFO/FIFO queues.

Date: 10/giu/2009 Time: 19:22:03

Version:

1.0

Author:

Bertoli Marco

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
CircularList()	Builds a new Circual list, using the default size
CircularList(int initialSize)	Builds a new CircularList with the given initial size

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)
boolean	add(E o)
boolean	addAll(int index, Collection<? extends E> c)
void	addFirst(E o)	Adds an object at the beginning of the list
void	addLast(E o)	Adds an object to the end of the list.
void	clear()
Object	clone()
E	get(int index)
E	getFirst()	Returns the first.
E	getLast()	Returns the last.
int	indexOf(Object o)
int	lastIndexOf(Object o)
E	remove(int index)
E	removeFirst()	Removes the first element of the list and returns it.
E	removeLast()	Removes the last element of the list and returns it
protected void	removeRange(int fromIndex, int toIndex)
E	set(int index, E element)
int	size()

Methods inherited from class AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addAll, contains, containsAll, equals, hashCode, isEmpty, iterator, listIterator, listIterator, remove, removeAll, replaceAll, retainAll, reversed, sort, spliterator, subList, toArray, toArray

Constructor Details

CircularList

public CircularList()

Builds a new Circual list, using the default size

CircularList

public CircularList(int initialSize)

Builds a new CircularList with the given initial size

Parameters:

initialSize - the initial size

Method Details

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

add

public boolean add(E o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

addFirst

public void addFirst(E o)

Adds an object at the beginning of the list

Specified by:

addFirst in interface List<E>

Specified by:

addFirst in interface SequencedCollection<E>

Parameters:

o - the object to add

addLast

public void addLast(E o)

Adds an object to the end of the list. it is a copy of add method.

Specified by:

addLast in interface List<E>

Specified by:

addLast in interface SequencedCollection<E>

Parameters:

o - the object to add

See Also:

• add(Object)

addAll

public boolean addAll(int index,
 Collection<? extends E> c)

Specified by:

addAll in interface List<E>

Overrides:

addAll in class AbstractList<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

clone

public Object clone()

Overrides:

clone in class Object

get

public E get(int index)

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

getFirst

public E getFirst()

Returns the first.

Specified by:

getFirst in interface List<E>

Specified by:

getFirst in interface SequencedCollection<E>

Returns:

the first element of the list

Throws:

IllegalArgumentException - if the list is empty

getLast

public E getLast()

Returns the last.

Specified by:

getLast in interface List<E>

Specified by:

getLast in interface SequencedCollection<E>

Returns:

the last element of the list

Throws:

IllegalArgumentException - if the list is empty

add

public void add(int index,
 E element)

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<E>

Overrides:

indexOf in class AbstractList<E>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<E>

Overrides:

lastIndexOf in class AbstractList<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

removeFirst

public E removeFirst()

Removes the first element of the list and returns it.

Specified by:

removeFirst in interface List<E>

Specified by:

removeFirst in interface SequencedCollection<E>

Returns:

the first element of the list

Throws:

IndexOutOfBoundsException - if size is zero

removeLast

public E removeLast()

Removes the last element of the list and returns it

Specified by:

removeLast in interface List<E>

Specified by:

removeLast in interface SequencedCollection<E>

Returns:

the last element of the list

Throws:

IndexOutOfBoundsException - if size is zero

removeRange

protected void removeRange(int fromIndex,
 int toIndex)

Overrides:

removeRange in class AbstractList<E>

set

public E set(int index,
 E element)

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>