net.sf.octet.util
Class OrderedSet

java.lang.Object
  net.sf.octet.util.OrderedSet

All Implemented Interfaces:

java.util.Collection, java.util.List, java.util.Set

public class OrderedSet

extends java.lang.Object

implements java.util.List, java.util.Set

OrderedSet is an implementation of the java.util.Collection interface that contains an ordered group of unique elements. Ordering is determined by the insertion sequence, as specified by the java.util.Listcontract. null is not permitted. This implementation is backed by a java.util.ArrayList.

Author:

Richard Apodaca

Constructor Summary

OrderedSet()
Constructs an empty and fully functional OrderedSet.

OrderedSet(java.util.Collection collection)
Constructs a OrderedSet by attempting to add all of the elements of collection.

Method Summary

void	add(int index, java.lang.Object o)
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection collection)
boolean	addAll(int index, java.util.Collection collection)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection collection)
java.lang.Object	get(int index)
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator	listIterator()
java.util.ListIterator	listIterator(int index)
java.lang.Object	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection collection)
boolean	retainAll(java.util.Collection collection)
java.lang.Object	set(int index, java.lang.Object o)
int	size()
java.util.List	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Methods inherited from interface java.util.Set

equals, hashCode

Constructor Detail

OrderedSet

public OrderedSet()

Constructs an empty and fully functional OrderedSet.

OrderedSet

public OrderedSet(java.util.Collection collection)

Constructs a OrderedSet by attempting to add all of the elements of collection. If collection contains null, a NullPointerException is thrown.

Parameters:

collection -

Throws:

java.lang.NullPointerException - if collection contains null

Method Detail

size

public int size()

Specified by:

size in interface java.util.List

clear

public void clear()

Specified by:

clear in interface java.util.List

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.List

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.List

get

public java.lang.Object get(int index)

Specified by:

get in interface java.util.List

remove

public java.lang.Object remove(int index)

Specified by:

remove in interface java.util.List

add

public void add(int index,
                java.lang.Object o)

Specified by:

add in interface java.util.List

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.List

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.List

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.List

addAll

public boolean addAll(int index,
                      java.util.Collection collection)

Specified by:

addAll in interface java.util.List

addAll

public boolean addAll(java.util.Collection collection)

Specified by:

addAll in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection collection)

Specified by:

containsAll in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection collection)

Specified by:

removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection collection)

Specified by:

retainAll in interface java.util.List

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.util.List

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

Specified by:

subList in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

Specified by:

listIterator in interface java.util.List

set

public java.lang.Object set(int index,
                            java.lang.Object o)

Specified by:

set in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Specified by:

toArray in interface java.util.List