com.im.commons.util
Class CaseInsensitiveSet

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<String>
          com.im.commons.util.CaseInsensitiveSet

All Implemented Interfaces:

Serializable, Iterable<String>, Collection<String>, Set<String>

public class CaseInsensitiveSet
extends AbstractSet<String>
implements Serializable

See Also:

Serialized Form

Constructor Summary

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

CaseInsensitiveSet(Collection c)
Constructs a new set containing the elements in the specified collection.

CaseInsensitiveSet(int initialCapacity)
Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and default load factor, which is 0.75.

CaseInsensitiveSet(int initialCapacity, float loadFactor)
Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and the specified load factor.

Method Summary

boolean	add(String o) Adds the specified element to this set if it is not already present.
void	clear() Removes all of the elements from this set.
Object	clone() Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.
boolean	contains(Object o) Returns true if this set contains the specified element.
boolean	isEmpty() Returns true if this set contains no elements.
Iterator<String>	iterator() Returns an iterator over the elements in this set.
boolean	remove(Object o) Removes the specified element from this set if it is present.
int	size() Returns the number of elements in this set (its cardinality).

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, toArray, toArray

Constructor Detail

CaseInsensitiveSet

public CaseInsensitiveSet()

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

CaseInsensitiveSet

public CaseInsensitiveSet(Collection c)

Constructs a new set containing the elements in the specified collection. The HashMap 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:

NullPointerException - if the specified collection is null.

CaseInsensitiveSet

public CaseInsensitiveSet(int initialCapacity,
                          float loadFactor)

Constructs a new, empty set; the backing HashMap 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:

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

CaseInsensitiveSet

public CaseInsensitiveSet(int initialCapacity)

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

Parameters:

initialCapacity - The initial capacity of the hash table.

Throws:

IllegalArgumentException - if the initial capacity is less than zero.

Method Detail

iterator

public Iterator<String> iterator()

Returns an iterator over the elements in this set. The elements are returned in no particular order.

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Set<String>

Specified by:

iterator in class AbstractCollection<String>

Returns:

An Iterator over the elements in this set.

See Also:

ConcurrentModificationException

size

public int size()

Returns the number of elements in this set (its cardinality).

Specified by:

size in interface Collection<String>

Specified by:

size in interface Set<String>

Specified by:

size in class AbstractCollection<String>

Returns:

The number of elements in this set (its cardinality).

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface Collection<String>

Specified by:

isEmpty in interface Set<String>

Overrides:

isEmpty in class AbstractCollection<String>

Returns:

true if this set contains no elements.

contains

public boolean contains(Object o)

Returns true if this set contains the specified element.

Specified by:

contains in interface Collection<String>

Specified by:

contains in interface Set<String>

Overrides:

contains in class AbstractCollection<String>

Parameters:

o - The e lement whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

add

public boolean add(String o)

Adds the specified element to this set if it is not already present.

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

Overrides:

add in class AbstractCollection<String>

Parameters:

o - The e lement to be added to this set.

Returns:

true if the set did not already contain the specified element.

remove

public boolean remove(Object o)

Removes the specified element from this set if it is present.

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface Set<String>

Overrides:

remove in class AbstractCollection<String>

Parameters:

o - The o bject to be removed from this set, if present.

Returns:

true if the set contained the specified element.

clear

public void clear()

Removes all of the elements from this set.

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface Set<String>

Overrides:

clear in class AbstractCollection<String>

clone

public Object clone()

Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.

Overrides:

clone in class Object

Returns:

A shallow copy of this set.