Package org.plumelib.util

Class IdentityArraySet<E extends @UnknownSignedness Object>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.plumelib.util.IdentityArraySet<E>

Type Parameters:

E - the type of the set elements

All Implemented Interfaces:

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

public class IdentityArraySet<E extends @UnknownSignedness Object>
extends AbstractSet<E>

A set backed by an array. It uses object identity (==) for comparison. It permits null values and its iterator has deterministic ordering.

Compared to a set built on IdentityHashMap: For very small sets, this uses much less space, has comparable performance, and (like a LinkedHashSet) is deterministic, with elements returned in the order they were inserted. For large sets, this is significantly less performant than other set implementations.

Constructor Summary

Constructors

Constructor	Description
IdentityArraySet()	Constructs an empty IdentityArraySet with the default initial capacity.
IdentityArraySet(int initialCapacity)	Constructs an empty IdentityArraySet with the specified initial capacity.
IdentityArraySet(Collection<? extends E> m)	Constructs a new IdentityArraySet with the same elements as the given collection.

Method Summary

Modifier and Type	Method	Description
boolean	add(E value)
boolean	addAll(Collection<? extends E> c)
void	clear()
IdentityArraySet<E>	clone()	Returns a copy of this.
boolean	contains(@GuardSatisfied @Nullable @UnknownSignedness Object value)
void	forEach(Consumer<? super E> action)
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(@GuardSatisfied @Nullable @UnknownSignedness Object value)
boolean	removeAll(Collection<?> c)
@org.checkerframework.checker.index.qual.NonNegative int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

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.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Set

containsAll, retainAll, spliterator, toArray, toArray

Constructor Details

IdentityArraySet

@SideEffectFree
public IdentityArraySet(int initialCapacity)

Constructs an empty IdentityArraySet with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity

Throws:

IllegalArgumentException - if the initial capacity is negative

IdentityArraySet

@SideEffectFree
public IdentityArraySet()

Constructs an empty IdentityArraySet with the default initial capacity.

IdentityArraySet

@SideEffectFree
public IdentityArraySet(Collection<? extends E> m)

Constructs a new IdentityArraySet with the same elements as the given collection.

Parameters:

m - the collection whose elements are to be placed in the new set

Throws:

NullPointerException - if the given set is null

Method Details

size

@Pure
public @org.checkerframework.checker.index.qual.NonNegative int size()

Specified by:

size in interface Collection<E extends @UnknownSignedness Object>

Specified by:

size in interface Set<E extends @UnknownSignedness Object>

Specified by:

size in class AbstractCollection<E extends @UnknownSignedness Object>

isEmpty

@Pure
public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E extends @UnknownSignedness Object>

Specified by:

isEmpty in interface Set<E extends @UnknownSignedness Object>

Overrides:

isEmpty in class AbstractCollection<E extends @UnknownSignedness Object>

contains

@Pure
public boolean contains(@GuardSatisfied @Nullable @UnknownSignedness Object value)

Specified by:

contains in interface Collection<E extends @UnknownSignedness Object>

Specified by:

contains in interface Set<E extends @UnknownSignedness Object>

Overrides:

contains in class AbstractCollection<E extends @UnknownSignedness Object>

add

public boolean add(E value)

Specified by:

add in interface Collection<E extends @UnknownSignedness Object>

Specified by:

add in interface Set<E extends @UnknownSignedness Object>

Overrides:

add in class AbstractCollection<E extends @UnknownSignedness Object>

remove

public boolean remove(@GuardSatisfied @Nullable @UnknownSignedness Object value)

Specified by:

remove in interface Collection<E extends @UnknownSignedness Object>

Specified by:

remove in interface Set<E extends @UnknownSignedness Object>

Overrides:

remove in class AbstractCollection<E extends @UnknownSignedness Object>

addAll

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

Specified by:

addAll in interface Collection<E extends @UnknownSignedness Object>

Specified by:

addAll in interface Set<E extends @UnknownSignedness Object>

Overrides:

addAll in class AbstractCollection<E extends @UnknownSignedness Object>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E extends @UnknownSignedness Object>

Specified by:

removeAll in interface Set<E extends @UnknownSignedness Object>

Overrides:

removeAll in class AbstractSet<E extends @UnknownSignedness Object>

clear

public void clear()

Specified by:

clear in interface Collection<E extends @UnknownSignedness Object>

Specified by:

clear in interface Set<E extends @UnknownSignedness Object>

Overrides:

clear in class AbstractCollection<E extends @UnknownSignedness Object>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E extends @UnknownSignedness Object>

Specified by:

iterator in interface Iterable<E extends @UnknownSignedness Object>

Specified by:

iterator in interface Set<E extends @UnknownSignedness Object>

Specified by:

iterator in class AbstractCollection<E extends @UnknownSignedness Object>

forEach

public void forEach(Consumer<? super E> action)

clone

@SideEffectFree
public IdentityArraySet<E> clone()

Returns a copy of this.

Overrides:

clone in class Object

Returns:

a copy of this