zombie.core.Collections
Class ZomboidHashSet<E>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<E>
          zombie.core.Collections.ZomboidHashSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

public class ZomboidHashSet<E>
extends java.util.AbstractSet<E>
implements java.util.Set<E>, java.lang.Cloneable, java.io.Serializable

Author:

LEMMY

See Also:

Serialized Form

Constructor Summary

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

ZomboidHashSet(java.util.Collection<? extends E> c)
Constructs a new set containing the elements in the specified collection.

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

ZomboidHashSet(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(E e) Adds the specified element to this set if it is not already present.
void	clear() Removes all of the elements from this set.
java.lang.Object	clone() Returns a shallow copy of this ZomboidHashSet instance: the elements themselves are not cloned.
boolean	contains(java.lang.Object o) Returns true if this set contains the specified element.
boolean	isEmpty() Returns true if this set contains no elements.
java.util.Iterator<E>	iterator() Returns an iterator over the elements in this set.
boolean	remove(java.lang.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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Constructor Detail

ZomboidHashSet

public ZomboidHashSet()

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

ZomboidHashSet

public ZomboidHashSet(java.util.Collection<? extends E> 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:

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

ZomboidHashSet

public ZomboidHashSet(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:

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

ZomboidHashSet

public ZomboidHashSet(int initialCapacity)

Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and default load factor (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

iterator

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

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

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.Set<E>

Specified by:

iterator in class java.util.AbstractCollection<E>

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 java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

Specified by:

size in class java.util.AbstractCollection<E>

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 java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>

Returns:

true if this set contains no elements

contains

public boolean contains(java.lang.Object o)

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

Overrides:

contains in class java.util.AbstractCollection<E>

Parameters:

o - element whose presence in this set is to be tested

Returns:

true if this set contains the specified element

add

public boolean add(E e)

Adds the specified element to this set if it is not already present. More formally, adds the specified element e to this set if this set contains no element e2 such that (e==null ? e2==null : e.equals(e2)). If this set already contains the element, the call leaves the set unchanged and returns false.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

Overrides:

add in class java.util.AbstractCollection<E>

Parameters:

e - element to be added to this set

Returns:

true if this set did not already contain the specified element

remove

public boolean remove(java.lang.Object o)

Removes the specified element from this set if it is present. More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

Overrides:

remove in class java.util.AbstractCollection<E>

Parameters:

o - object 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. The set will be empty after this call returns.

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

Overrides:

clear in class java.util.AbstractCollection<E>

clone

public java.lang.Object clone()

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

Overrides:

clone in class java.lang.Object

Returns:

a shallow copy of this set