org.libj.util.primitive

Interface LongSet

All Superinterfaces:

Cloneable, LongCollection, LongIterable, PrimitiveCollection, Serializable

All Known Implementing Classes:

HashLongSet

@Generated(value="Autogenerated by OpenJAX CodeGen Template (0.2.5)",
           date="2020-05-23")
public interface LongSet
extends LongCollection

A collection of long values that contains no duplicates. More formally, long-sets contain no pair of values v1 and v2 such that e1 == e2. As implied by its name, this interface models the mathematical set abstraction.

This interface is a replica of the Set interface that defines synonymous methods for a list of long values instead of Object references.

Method Summary

Modifier and Type	Method and Description
boolean	add(long value) Adds the specified value to this set if it is not already present.
boolean	addAll(Collection<Long> c) Adds all of the values in the specified collection to this set if they're not already present.
boolean	addAll(LongCollection c) Adds all of the values in the specified collection to this set if they're not already present.
void	clear() Removes all of the values from this set.
boolean	contains(long value) Returns true if this set contains the specified value.
boolean	containsAll(Collection<Long> c) Returns true if this set contains all of the values of the specified collection.
boolean	containsAll(LongCollection c) Returns true if this set contains all of the values of the specified collection.
boolean	equals(Object obj) Compares the specified object with this set for equality.
int	hashCode() Returns the hash code value for this set.
boolean	isEmpty() Returns true if this set contains no values.
LongIterator	iterator() Returns an iterator over the values in this set.
boolean	remove(long value) Removes the specified value from this set if it is present.
boolean	removeAll(Collection<Long> c) Removes from this set all of its values that are contained in the specified collection.
boolean	removeAll(LongCollection c) Removes from this set all of its values that are contained in the specified collection.
boolean	retainAll(Collection<Long> c) Retains only the values in this set that are contained in the specified collection.
boolean	retainAll(LongCollection c) Retains only the values in this set that are contained in the specified collection.
int	size() Returns the number of values in this set (its cardinality).
Spliterator.OfLong	spliterator() Creates a Spliterator.OfLong over the elements in this set.

Methods inherited from interface org.libj.util.primitive.LongCollection

addAll, parallelStream, removeAll, removeIf, stream, toArray, toArray, toArray

Method Detail

add

boolean add(long value)

Adds the specified value to this set if it is not already present. More formally, adds the specified value value to this set if the set contains no value value2 such that value == value2. If this set already contains the value, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate values.

Specified by:

add in interface LongCollection

Parameters:

value - Value to be added to this set.

Returns:

true if this set did not already contain the specified value.

addAll

boolean addAll(Collection<Long> c)

Adds all of the values in the specified collection to this set if they're not already present. If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

addAll in interface LongCollection

Parameters:

c - Collection containing values to be added to this set.

Returns:

true if this set changed as a result of the call.

Throws:

ClassCastException - If the class of an element of the specified collection is not Long.

NullPointerException - If the specified collection contains one or more null values, or if the specified collection is null.

See Also:

addAll(LongCollection), add(long)

addAll

boolean addAll(LongCollection c)

Adds all of the values in the specified collection to this set if they're not already present. If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

addAll in interface LongCollection

Parameters:

c - Collection containing values to be added to this set.

Returns:

true if this set changed as a result of the call.

Throws:

NullPointerException - If the specified collection contains one or more null values, or if the specified collection is null.

See Also:

addAll(Collection), add(long)

contains

boolean contains(long value)

Returns true if this set contains the specified value. More formally, returns true if and only if this set contains a value v such that Objects.equals(value, v).

Specified by:

contains in interface LongCollection

Parameters:

value - Value whose presence in this set is to be tested.

Returns:

true if this set contains the specified value.

containsAll

boolean containsAll(Collection<Long> c)

Returns true if this set contains all of the values of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Specified by:

containsAll in interface LongCollection

Parameters:

c - Collection to be checked for containment in this set.

Returns:

true if this set contains all of the values of the specified collection.

Throws:

ClassCastException - If the class of an element of the specified collection is not Long.

NullPointerException - If the specified collection contains one or more null values, or if the specified collection is null.

See Also:

containsAll(LongCollection), contains(long)

containsAll

boolean containsAll(LongCollection c)

Returns true if this set contains all of the values of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Specified by:

containsAll in interface LongCollection

Parameters:

c - Collection to be checked for containment in this set.

Returns:

true if this set contains all of the values of the specified collection.

See Also:

containsAll(Collection), contains(long)

remove

boolean remove(long value)

Removes the specified value from this set if it is present. More formally, removes an value v such that Objects.equals(value, v), if this set contains such an value. Returns true if this set contained the value (or equivalently, if this set changed as a result of the call). (This set will not contain the value once the call returns).

Specified by:

remove in interface LongCollection

Parameters:

value - Value to be removed from this set, if present.

Returns:

true if this set contained the specified value.

removeAll

boolean removeAll(Collection<Long> c)

Removes from this set all of its values that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Specified by:

removeAll in interface LongCollection

Parameters:

c - Collection containing values to be removed from this set.

Returns:

true if this set changed as a result of the call.

Throws:

ClassCastException - If the class of an element of the specified collection is not Long.

NullPointerException - If the specified collection contains a null value, or if the specified collection is null.

See Also:

removeAll(LongCollection), remove(long), contains(long)

removeAll

boolean removeAll(LongCollection c)

Removes from this set all of its values that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Specified by:

removeAll in interface LongCollection

Parameters:

c - Collection containing values to be removed from this set.

Returns:

true if this set changed as a result of the call.

Throws:

NullPointerException - If the specified collection contains a null value, or if the specified collection is null.

See Also:

removeAll(Collection), remove(long), contains(long)

retainAll

boolean retainAll(Collection<Long> c)

Retains only the values in this set that are contained in the specified collection. In other words, removes from this set all of its values that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Specified by:

retainAll in interface LongCollection

Parameters:

c - Collection containing values to be retained in this set.

Returns:

true if this set changed as a result of the call.

Throws:

ClassCastException - If the class of an element of the specified collection is not Long.

NullPointerException - If the specified collection contains a null value, or if the specified collection is null.

See Also:

retainAll(LongCollection), remove(long), contains(long)

retainAll

boolean retainAll(LongCollection c)

Retains only the values in this set that are contained in the specified collection. In other words, removes from this set all of its values that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Specified by:

retainAll in interface LongCollection

Parameters:

c - Collection containing values to be retained in this set.

Returns:

true if this set changed as a result of the call.

Throws:

NullPointerException - If the specified collection contains a null value, or if the specified collection is null.

See Also:

retainAll(Collection), remove(long), contains(long)

clear

void clear()

Removes all of the values from this set. The set will be empty after this call returns.

Specified by:

clear in interface PrimitiveCollection

size

int size()

Returns the number of values in this set (its cardinality). If this set contains more than Long.MAX_VALUE values, returns Long.MAX_VALUE.

Specified by:

size in interface PrimitiveCollection

Returns:

The number of values in this set (its cardinality).

isEmpty

boolean isEmpty()

Returns true if this set contains no values.

Specified by:

isEmpty in interface PrimitiveCollection

Returns:

true if this set contains no values.

iterator

LongIterator iterator()

Returns an iterator over the values in this set. The values are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Specified by:

iterator in interface LongIterable

Returns:

An iterator over the values in this set.

spliterator

Spliterator.OfLong spliterator()

Creates a Spliterator.OfLong over the elements in this set.

The Spliterator.OfLong reports Spliterator.DISTINCT.

Specified by:

spliterator in interface LongCollection

Returns:

A Spliterator.OfLong over the elements in this set.

See Also:

Spliterator.OfLong

equals

boolean equals(Object obj)

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Specified by:

equals in interface PrimitiveCollection

Overrides:

equals in class Object

Parameters:

obj - Object to be compared for equality with this set.

Returns:

true if the specified object is equal to this set.

See Also:

Object.equals(Object), IntSet.equals(Object), IntList.equals(Object)

hashCode

int hashCode()

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the values in the set. This ensures that s1 == s2 implies that s1.hashCode() == s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().

Specified by:

hashCode in interface PrimitiveCollection

Overrides:

hashCode in class Object

Returns:

The hash code value for this set.

See Also:

Object.equals(Object), equals(Object)