Package io.permazen.core.util

Class ObjIdSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<ObjId>

io.permazen.core.util.ObjIdSet

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ObjId>, Collection<ObjId>, Set<ObjId>

@NotThreadSafe
public class ObjIdSet
extends AbstractSet<ObjId>
implements Cloneable, Serializable

A set of ObjIds.

This implementation is space optimized for the 64-bits of information contained in an ObjId. Instances do not accept null values and are not thread safe.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ObjIdSet()	Constructs an empty instance.
ObjIdSet(int capacity)	Constructs an instance with the given initial capacity.
ObjIdSet(Iterable<? extends ObjId> ids)	Constructs an instance initialized with the given ID's.

Method Summary

Modifier and Type	Method	Description
boolean	add(ObjId id)
void	clear()
ObjIdSet	clone()
boolean	contains(Object obj)
int	hashCode()
boolean	isEmpty()
Iterator<ObjId>	iterator()
boolean	remove(Object obj)
ObjId	removeOne()	Remove a single, arbitrary ObjId from this instance and return it.
int	size()
ImmutableNavigableSet<ObjId>	sortedSnapshot()	Create a sorted, immutable snapshot of this instance.
ObjId[]	toArray()
long[]	toLongArray()

Methods inherited from class java.util.AbstractSet

equals, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, 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.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, spliterator, toArray

Constructor Details

ObjIdSet

public ObjIdSet()

Constructs an empty instance.

ObjIdSet

public ObjIdSet(int capacity)

Constructs an instance with the given initial capacity.

Parameters:

capacity - initial capacity

Throws:

IllegalArgumentException - if capacity is negative

ObjIdSet

public ObjIdSet(Iterable<? extends ObjId> ids)

Constructs an instance initialized with the given ID's.

Parameters:

ids - initial contents for this instance

Throws:

IllegalArgumentException - if ids is null

NullPointerException - if any ID in ids is null

Method Details

removeOne

public ObjId removeOne()

Remove a single, arbitrary ObjId from this instance and return it.

Returns:

the removed ObjId, or null if this instance is empty

iterator

public Iterator<ObjId> iterator()

Specified by:

iterator in interface Collection<ObjId>

Specified by:

iterator in interface Iterable<ObjId>

Specified by:

iterator in interface Set<ObjId>

Specified by:

iterator in class AbstractCollection<ObjId>

size

public int size()

Specified by:

size in interface Collection<ObjId>

Specified by:

size in interface Set<ObjId>

Specified by:

size in class AbstractCollection<ObjId>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<ObjId>

Specified by:

isEmpty in interface Set<ObjId>

Overrides:

isEmpty in class AbstractCollection<ObjId>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<ObjId>

Specified by:

contains in interface Set<ObjId>

Overrides:

contains in class AbstractCollection<ObjId>

add

public boolean add(ObjId id)

Specified by:

add in interface Collection<ObjId>

Specified by:

add in interface Set<ObjId>

Overrides:

add in class AbstractCollection<ObjId>

remove

public boolean remove(Object obj)

Specified by:

remove in interface Collection<ObjId>

Specified by:

remove in interface Set<ObjId>

Overrides:

remove in class AbstractCollection<ObjId>

clear

public void clear()

Specified by:

clear in interface Collection<ObjId>

Specified by:

clear in interface Set<ObjId>

Overrides:

clear in class AbstractCollection<ObjId>

toArray

public ObjId[] toArray()

Specified by:

toArray in interface Collection<ObjId>

Specified by:

toArray in interface Set<ObjId>

Overrides:

toArray in class AbstractCollection<ObjId>

toLongArray

public long[] toLongArray()

sortedSnapshot

public ImmutableNavigableSet<ObjId> sortedSnapshot()

Create a sorted, immutable snapshot of this instance.

Returns:

sorted, immutable snapshot

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<ObjId>

Specified by:

hashCode in interface Set<ObjId>

Overrides:

hashCode in class AbstractSet<ObjId>

clone

public ObjIdSet clone()

Overrides:

clone in class Object