org.checkerframework.dataflow.util

Class AbstractMostlySingleton<T>

java.lang.Object

org.checkerframework.dataflow.util.AbstractMostlySingleton<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>

Direct Known Subclasses:

IdentityMostlySingleton, MostlySingleton

public abstract class AbstractMostlySingleton<T>
extends Object
implements Set<T>

Base class for arbitrary-size sets that very efficient (more efficient than HashSet) for 0 and 1 elements.

Does not support storing null.

This class exists because it has multiple subclasses (currently MostlySingleton and IdentityMostlySingleton).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMostlySingleton.State The possible states of this set.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable Set<T>	set The wrapped set, non-null when the state is ANY.
protected AbstractMostlySingleton.State	state The current state.
protected T	value The current value, non-null when the state is SINGLETON.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMostlySingleton(AbstractMostlySingleton.State s) Create an AbstractMostlySingleton.
protected	AbstractMostlySingleton(AbstractMostlySingleton.State s, T v) Create an AbstractMostlySingleton.

Method Summary

Modifier and Type	Method and Description
boolean	addAll(Collection<? extends T> c)
void	clear()
boolean	containsAll(Collection<?> c)
boolean	isEmpty()
Iterator<T>	iterator()
boolean	remove(@Nullable Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<S> S[]	toArray(S[] a)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, contains, equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

state

protected AbstractMostlySingleton.State state

The current state.

value

protected T value

The current value, non-null when the state is SINGLETON.

set

protected @Nullable Set<T> set

The wrapped set, non-null when the state is ANY.

Constructor Detail

AbstractMostlySingleton

protected AbstractMostlySingleton(AbstractMostlySingleton.State s)

Create an AbstractMostlySingleton.

AbstractMostlySingleton

protected AbstractMostlySingleton(AbstractMostlySingleton.State s,
                                  T v)

Create an AbstractMostlySingleton.

Method Detail

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Set<T>

toString

public String toString()

Overrides:

toString in class Object

addAll

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

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

toArray

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

remove

public boolean remove(@Nullable Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>