com.partnersoft.data

Class CircularList<V>

java.lang.Object

com.partnersoft.data.CircularList<V>

Type Parameters:

V -

All Implemented Interfaces:

java.lang.Iterable<V>, java.util.Collection<V>, java.util.List<V>

public class CircularList<V>
extends java.lang.Object
implements java.util.List<V>

A list which can be iterated infinitely, alternating through the contents.

Yes, that means that the iterator's hasNext() method will never return false if there's anything in the contents list... beware.

Copyright 2012 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
CircularList()
CircularList(java.lang.Iterable<V> contents)
CircularList(java.util.List<V> contents)
CircularList(V... contents)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, V value)
boolean	add(V value)
boolean	addAll(java.util.Collection<? extends V> values)
boolean	addAll(int index, java.util.Collection<? extends V> values)
void	clear()
boolean	contains(java.lang.Object value)
boolean	containsAll(java.util.Collection<?> values)
boolean	equals(java.lang.Object nother)
V	get(int index)
java.util.List<V>	getContents()
int	hashCode()
int	indexOf(java.lang.Object value)
boolean	isEmpty()
java.util.Iterator<V>	iterator()
int	lastIndexOf(java.lang.Object value)
java.util.ListIterator<V>	listIterator()
java.util.ListIterator<V>	listIterator(int index)
V	remove(int index)
boolean	remove(java.lang.Object value)
boolean	removeAll(java.util.Collection<?> values)
boolean	retainAll(java.util.Collection<?> values)
V	set(int index, V value)
void	setContents(java.util.List<V> contents)
int	size()
java.util.List<V>	subList(int index1, int index2)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] template)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularList

public CircularList()

CircularList

public CircularList(java.util.List<V> contents)

CircularList

public CircularList(V... contents)

CircularList

public CircularList(java.lang.Iterable<V> contents)

Method Detail

iterator

public java.util.Iterator<V> iterator()

Specified by:

iterator in interface java.lang.Iterable<V>

Specified by:

iterator in interface java.util.Collection<V>

Specified by:

iterator in interface java.util.List<V>

add

public boolean add(V value)

Specified by:

add in interface java.util.Collection<V>

Specified by:

add in interface java.util.List<V>

add

public void add(int index,
       V value)

Specified by:

add in interface java.util.List<V>

addAll

public boolean addAll(java.util.Collection<? extends V> values)

Specified by:

addAll in interface java.util.Collection<V>

Specified by:

addAll in interface java.util.List<V>

addAll

public boolean addAll(int index,
             java.util.Collection<? extends V> values)

Specified by:

addAll in interface java.util.List<V>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<V>

Specified by:

clear in interface java.util.List<V>

contains

public boolean contains(java.lang.Object value)

Specified by:

contains in interface java.util.Collection<V>

Specified by:

contains in interface java.util.List<V>

containsAll

public boolean containsAll(java.util.Collection<?> values)

Specified by:

containsAll in interface java.util.Collection<V>

Specified by:

containsAll in interface java.util.List<V>

get

public V get(int index)

Specified by:

get in interface java.util.List<V>

indexOf

public int indexOf(java.lang.Object value)

Specified by:

indexOf in interface java.util.List<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<V>

Specified by:

isEmpty in interface java.util.List<V>

lastIndexOf

public int lastIndexOf(java.lang.Object value)

Specified by:

lastIndexOf in interface java.util.List<V>

listIterator

public java.util.ListIterator<V> listIterator()

Specified by:

listIterator in interface java.util.List<V>

listIterator

public java.util.ListIterator<V> listIterator(int index)

Specified by:

listIterator in interface java.util.List<V>

remove

public boolean remove(java.lang.Object value)

Specified by:

remove in interface java.util.Collection<V>

Specified by:

remove in interface java.util.List<V>

remove

public V remove(int index)

Specified by:

remove in interface java.util.List<V>

removeAll

public boolean removeAll(java.util.Collection<?> values)

Specified by:

removeAll in interface java.util.Collection<V>

Specified by:

removeAll in interface java.util.List<V>

retainAll

public boolean retainAll(java.util.Collection<?> values)

Specified by:

retainAll in interface java.util.Collection<V>

Specified by:

retainAll in interface java.util.List<V>

set

public V set(int index,
    V value)

Specified by:

set in interface java.util.List<V>

size

public int size()

Specified by:

size in interface java.util.Collection<V>

Specified by:

size in interface java.util.List<V>

subList

public java.util.List<V> subList(int index1,
                        int index2)

Specified by:

subList in interface java.util.List<V>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<V>

Specified by:

toArray in interface java.util.List<V>

toArray

public <T> T[] toArray(T[] template)

Specified by:

toArray in interface java.util.Collection<V>

Specified by:

toArray in interface java.util.List<V>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object nother)

Specified by:

equals in interface java.util.Collection<V>

Specified by:

equals in interface java.util.List<V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<V>

Specified by:

hashCode in interface java.util.List<V>

Overrides:

hashCode in class java.lang.Object

getContents

public java.util.List<V> getContents()

setContents

public void setContents(java.util.List<V> contents)