org.cell2d.util

Class ArraySet<E>

java.lang.Object

org.cell2d.util.ArraySet<E>

Type Parameters:

E - The type of elements in this ArraySet

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

public class ArraySet<E>
extends java.lang.Object
implements java.util.Set<E>

An ArraySet is a Set implemented as a resizable array, just like that of an ArrayList. An ArraySet takes up less memory than other Set types, and offers at-least-comparable performance to a HashSet when the Set size is very small. For best results, the initial capacity of an ArraySet should be set to the smallest number that the ArraySet's size will almost certainly never exceed.

See Also:

ArrayList

Constructor Summary

Constructors

Constructor and Description
ArraySet() Constructs an empty ArraySet with an initial capacity of 10.
ArraySet(java.util.Collection<? extends E> c) Constructs an ArraySet containing the elements of the specified Collection.
ArraySet(int initialCapacity) Constructs an empty ArraySet with the specified initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(java.util.Collection<? extends E> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
void	ensureCapacity(int minCapacity) Increases the capacity of this ArraySet, if necessary, to be at least the specified minimum capacity.
boolean	isEmpty()
java.util.Iterator<E>	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()
<T> T[]	toArray(T[] a)
void	trimToSize() Trims the capacity of this ArraySet to be equal to its current size.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

ArraySet

public ArraySet(int initialCapacity)

Constructs an empty ArraySet with the specified initial capacity.

Parameters:

initialCapacity - The initial capacity of the ArraySet

ArraySet

public ArraySet()

Constructs an empty ArraySet with an initial capacity of 10.

ArraySet

public ArraySet(java.util.Collection<? extends E> c)

Constructs an ArraySet containing the elements of the specified Collection. The ArraySet is created with enough initial capacity to hold these elements.

Parameters:

c - The Collection whose elements are to be placed into this ArraySet

Method Detail

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

iterator

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

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>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

containsAll

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

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.Set<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

retainAll

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

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

removeAll

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

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

trimToSize

public final void trimToSize()

Trims the capacity of this ArraySet to be equal to its current size. This operation runs in time proportional to the ArraySet's size, but it minimizes the amount of memory taken up by the ArraySet.

ensureCapacity

public final void ensureCapacity(int minCapacity)

Increases the capacity of this ArraySet, if necessary, to be at least the specified minimum capacity.

Parameters:

minCapacity - The minimum capacity that this ArraySet should have