Package net.i2p.router.util

Class ArraySet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

net.i2p.router.util.ArraySet<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>

public class ArraySet<E>
extends AbstractSet<E>
implements Set<E>

A small, fast Set with a maximum size, backed by a fixed-size array. Unsynchronized, not thread-safe. Null elements are not permitted. Not appropriate for large Sets.

Since:

0.9.25

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArraySet.SetFullException

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_CAPACITY

Constructor Summary

Constructors

Constructor	Description
ArraySet()	A fixed capacity of MAX_CAPACITY.
ArraySet(int capacity)	Adds over capacity will throw a SetFullException.
ArraySet(int capacity, boolean throwOnFull)	If throwOnFull is false, adds over capacity will overwrite starting at slot zero.
ArraySet(Collection<? extends E> c)	A fixed capacity of MAX_CAPACITY.

Method Summary

Modifier and Type	Method	Description
boolean	add(E o)
void	clear()
boolean	contains(Object o)
boolean	isEmpty()
Iterator<E>	iterator()	Supports remove.
boolean	remove(Object o)
int	size()

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

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

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

Field Detail

MAX_CAPACITY

public static final int MAX_CAPACITY

See Also:

Constant Field Values

Constructor Detail

ArraySet

public ArraySet()

A fixed capacity of MAX_CAPACITY. Adds over capacity will throw a SetFullException.

ArraySet

public ArraySet(Collection<? extends E> c)

A fixed capacity of MAX_CAPACITY. Adds over capacity will throw a SetFullException.

Throws:

ArraySet.SetFullException - if more than MAX_CAPACITY unique elements in c.

ArraySet

public ArraySet(int capacity)

Adds over capacity will throw a SetFullException.

Parameters:

capacity - the maximum size

Throws:

IllegalArgumentException - if capacity less than 1 or more than MAX_CAPACITY.

ArraySet

public ArraySet(int capacity,
                boolean throwOnFull)

If throwOnFull is false, adds over capacity will overwrite starting at slot zero. This breaks the AbstractCollection invariant that "a Collection will always contain the specified element after add() returns", but it prevents unexpected exceptions. If throwOnFull is true, adds over capacity will throw a SetFullException.

Parameters:

capacity - the maximum size

Throws:

IllegalArgumentException - if capacity less than 1 or more than MAX_CAPACITY.

Method Detail

add

public boolean add(E o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

Throws:

ArraySet.SetFullException - if throwOnFull was true in constructor

NullPointerException - if o is null

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Supports remove. Supports comodification checks.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>