com.day.util

Class OrderedSet

java.lang.Object

com.day.util.OrderedSet

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.Set

public class OrderedSet
extends java.lang.Object
implements java.util.Set

Helper class that implements a set, but preserves the order of inserting the elements when accessing an iterator.

Since:

coati, moved to com.day.util for iguana

Constructor Summary

Constructors

Constructor and Description
OrderedSet() Constructs a new, empty set; the backing HashMap instance has default initial capacity (16) and load factor (0.75).
OrderedSet(java.util.Collection c) Constructs a new set containing the elements in the specified collection.
OrderedSet(int initialCapacity) Constructs a new, empty set; the backing Set instance has the specified initial capacity and default load factor, which is 0.75.
OrderedSet(int initialCapacity, float loadFactor) Constructs a new, empty set; the backing Set instance has the specified initial capacity and the specified load factor.

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection c)
boolean	isEmpty()
java.util.Iterator	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	retainAll(java.util.Collection c)
int	size()
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

OrderedSet

public OrderedSet()

Constructs a new, empty set; the backing HashMap instance has default initial capacity (16) and load factor (0.75).

OrderedSet

public OrderedSet(java.util.Collection c)

Constructs a new set containing the elements in the specified collection. The Set is created with default load factor (0.75) and an initial capacity sufficient to contain the elements in the specified collection.

Parameters:

c - the collection whose elements are to be placed into this set.

Throws:

java.lang.NullPointerException - if the specified collection is null.

OrderedSet

public OrderedSet(int initialCapacity,
                  float loadFactor)

Constructs a new, empty set; the backing Set instance has the specified initial capacity and the specified load factor.

Parameters:

initialCapacity - the initial capacity of the hash map.

loadFactor - the load factor of the hash map.

Throws:

java.lang.IllegalArgumentException - if the initial capacity is less than zero, or if the load factor is nonpositive.

OrderedSet

public OrderedSet(int initialCapacity)

Constructs a new, empty set; the backing Set instance has the specified initial capacity and default load factor, which is 0.75.

Parameters:

initialCapacity - the initial capacity of the hash table.

Throws:

java.lang.IllegalArgumentException - if the initial capacity is less than zero.

Method Detail

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.Set

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.Set

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.Set

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

toArray

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

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.Set

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.Set

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.Set

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.Set