Package org.dellroad.stuff.util

Class LongSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Long>

org.dellroad.stuff.util.LongSet

All Implemented Interfaces:

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

public class LongSet
extends AbstractSet<Long>
implements Cloneable, Serializable

A set of non-zero long values.

This implementation uses long[] arrays and open addressing to minimize memory overhead. Equivalent Set methods taking long instead of Long are also provided.

Instances will throw IllegalStateException if their capacity is exceeded.

Instances do not accept zero values and are not thread safe.

See Also:

• Open addressing
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LongSet()	Constructs an empty instance.
LongSet(int capacity)	Constructs an instance with the given initial capacity.
LongSet(long[] values)	Constructs an instance initialized with the values in the given array.
LongSet(Iterable<? extends Number> values)	Constructs an instance initialized with the given values.

Method Summary

Modifier and Type	Method	Description
boolean	add(long value)
boolean	add(Long value)
void	clear()
LongSet	clone()
boolean	contains(long value)
boolean	contains(Object obj)
int	hashCode()
boolean	isEmpty()
Iterator<Long>	iterator()
LongStream	longStream()	Returns a sequential LongStream with this instance as its source.
boolean	remove(long value)
boolean	remove(Object obj)
long	removeOne()	Remove a single, arbitrary long value from this instance and return it.
int	size()
Long[]	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

LongSet

public LongSet()

Constructs an empty instance.

LongSet

public LongSet(int capacity)

Constructs an instance with the given initial capacity.

Parameters:

capacity - initial capacity

Throws:

IllegalArgumentException - if capacity is negative

LongSet

public LongSet(Iterable<? extends Number> values)

Constructs an instance initialized with the given values.

Parameters:

values - initial contents for this instance

Throws:

IllegalArgumentException - if values is null

IllegalArgumentException - if any value in values is null

IllegalArgumentException - if any value in values is zero

LongSet

public LongSet(long[] values)

Constructs an instance initialized with the values in the given array.

Parameters:

values - initial contents for this instance

Throws:

IllegalArgumentException - if values is null

NullPointerException - if any value in values is zero

Method Details

removeOne

public long removeOne()

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

Returns:

the removed value, or zero if this instance is empty

longStream

public LongStream longStream()

Returns a sequential LongStream with this instance as its source.

Returns:

stream of contents

iterator

public Iterator<Long> iterator()

Specified by:

iterator in interface Collection<Long>

Specified by:

iterator in interface Iterable<Long>

Specified by:

iterator in interface Set<Long>

Specified by:

iterator in class AbstractCollection<Long>

size

public int size()

Specified by:

size in interface Collection<Long>

Specified by:

size in interface Set<Long>

Specified by:

size in class AbstractCollection<Long>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Long>

Specified by:

isEmpty in interface Set<Long>

Overrides:

isEmpty in class AbstractCollection<Long>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<Long>

Specified by:

contains in interface Set<Long>

Overrides:

contains in class AbstractCollection<Long>

contains

public boolean contains(long value)

add

public boolean add(Long value)

Specified by:

add in interface Collection<Long>

Specified by:

add in interface Set<Long>

Overrides:

add in class AbstractCollection<Long>

add

public boolean add(long value)

remove

public boolean remove(Object obj)

Specified by:

remove in interface Collection<Long>

Specified by:

remove in interface Set<Long>

Overrides:

remove in class AbstractCollection<Long>

remove

public boolean remove(long value)

clear

public void clear()

Specified by:

clear in interface Collection<Long>

Specified by:

clear in interface Set<Long>

Overrides:

clear in class AbstractCollection<Long>

toArray

public Long[] toArray()

Specified by:

toArray in interface Collection<Long>

Specified by:

toArray in interface Set<Long>

Overrides:

toArray in class AbstractCollection<Long>

toLongArray

public long[] toLongArray()

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Long>

Specified by:

hashCode in interface Set<Long>

Overrides:

hashCode in class AbstractSet<Long>

clone

public LongSet clone()

Overrides:

clone in class Object