Package org.javimmutable.collections.hash

Class HashSet<T>

java.lang.Object

org.javimmutable.collections.common.AbstractSet<T>

org.javimmutable.collections.hash.HashSet<T>

All Implemented Interfaces:

Serializable, Iterable<T>, ArrayAssignMapper<T,T,ArraySetNode<T>>, ArrayContainsMapper<T,ArraySetNode<T>>, ArrayDeleteMapper<T,ArraySetNode<T>>, ArrayIterationMapper<T,T,ArraySetNode<T>>, ArraySizeMapper<ArraySetNode<T>>, ICollection<T>, InvariantCheckable, ISet<T>, IStreamable<T>, Mapped<T,T>, SplitableIterable<T>

@Immutable
public class HashSet<T>
extends AbstractSet<T>
implements ArrayAssignMapper<T,T,ArraySetNode<T>>, ArrayContainsMapper<T,ArraySetNode<T>>, ArrayIterationMapper<T,T,ArraySetNode<T>>, ArrayDeleteMapper<T,ArraySetNode<T>>, Serializable

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static <T> ISetBuilder<T>	builder()
void	checkInvariants()	Checks invariants of implementing class.
boolean	contains(T value)	Determines if the Set contains the specified value.
ISet<T>	delete(T value)	Removes the value from the Set.
ISet<T>	deleteAll()
ISet<T>	deleteAll(Iterator<? extends T> other)	Removes all values of other from the Set.
protected Set<T>	emptyMutableSet()	Implemented by derived classes to create a new empty Set
void	forEach(java.util.function.Consumer<? super T> action)
<E extends Exception> void	forEachThrows(Proc1Throws<T,E> proc)	Processes every value using the provided function.
int	getSpliteratorCharacteristics()
ISet<T>	insert(T value)	Adds the single value to the Set.
ISet<T>	intersection(Iterator<? extends T> values)	Removes all values from the Set that are not contained in the other collection.
ISet<T>	intersection(Set<? extends T> otherSet)	Removes all values from the Set that are not contained in the other collection.
boolean	isEmpty()
SplitableIterator<T>	iterator()	Overridden here to require implementations to return a SplitableIterator rather than a basic Iterator.
ArraySetNode<T>	mappedAssign(ArraySetNode<T> current, T key, T ignored)	Called during assign operation to replace an existing mapping for the given key and value.
ArraySetNode<T>	mappedAssign(T key, T ignored)	Called during assign operation to create a new mapping for the given key and value.
boolean	mappedContains(ArraySetNode<T> mapping, T key)
ArraySetNode<T>	mappedDelete(ArraySetNode<T> current, T key)	Called during delete operation to delete a key from a mapping.
GenericIterator.Iterable<IMapEntry<T,T>>	mappedEntries(ArraySetNode<T> mapping)
GenericIterator.Iterable<T>	mappedKeys(ArraySetNode<T> mapping)
int	mappedSize(ArraySetNode<T> mapping)	Called to obtain number of keys in a given mapping.
GenericIterator.Iterable<T>	mappedValues(ArraySetNode<T> mapping)
static <T> ISet<T>	of()
int	size()
ISet<T>	union(Iterator<? extends T> other)	Adds all values from other to the Set.

Methods inherited from class org.javimmutable.collections.common.AbstractSet

containsAll, containsAll, containsAny, containsAny, deleteAll, equals, getSet, hashCode, insertAll, insertAll, intersection, intersection, toString, union

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.javimmutable.collections.ICollection

isNonEmpty

Methods inherited from interface org.javimmutable.collections.ISet

find, get, getValueOr, reject, select, setCollector

Methods inherited from interface org.javimmutable.collections.IStreamable

parallelStream, spliterator, stream

Methods inherited from interface org.javimmutable.collections.SplitableIterable

indexedForEach, indexedForEachThrows, reduce, reduceThrows

Method Details

of

public static <T> ISet<T> of()

builder

@Nonnull
public static <T> ISetBuilder<T> builder()

deleteAll

@Nonnull
public ISet<T> deleteAll()

Specified by:

deleteAll in interface ICollection<T>

Specified by:

deleteAll in interface ISet<T>

Returns:

an equivalent collection with no values

emptyMutableSet

protected Set<T> emptyMutableSet()

Description copied from class: AbstractSet

Implemented by derived classes to create a new empty Set

Specified by:

emptyMutableSet in class AbstractSet<T>

insert

@Nonnull
public ISet<T> insert(@Nonnull
 T value)

Description copied from interface: ISet

Adds the single value to the Set.

Specified by:

insert in interface ICollection<T>

Specified by:

insert in interface ISet<T>

Returns:

instance of set containing the value

contains

public boolean contains(@Nullable
 T value)

Description copied from interface: ISet

Determines if the Set contains the specified value.

Specified by:

contains in interface ISet<T>

Returns:

true if the Set contains the value

delete

@Nonnull
public ISet<T> delete(T value)

Description copied from interface: ISet

Removes the value from the Set. Has no effect if the value is not in the Set.

Specified by:

delete in interface ISet<T>

Returns:

instance of set without the value

deleteAll

@Nonnull
public ISet<T> deleteAll(@Nonnull
 Iterator<? extends T> other)

Description copied from interface: ISet

Removes all values of other from the Set. Has no effect if none of the values are in the Set

Specified by:

deleteAll in interface ISet<T>

Returns:

instance of set without the values

union

@Nonnull
public ISet<T> union(@Nonnull
 Iterator<? extends T> other)

Description copied from interface: ISet

Adds all values from other to the Set.

Specified by:

union in interface ISet<T>

Parameters:

other - source of values to add

Returns:

instance of set containing the values

intersection

@Nonnull
public ISet<T> intersection(@Nonnull
 Iterator<? extends T> values)

Description copied from interface: ISet

Removes all values from the Set that are not contained in the other collection.

Specified by:

intersection in interface ISet<T>

Returns:

instance of set with unmatched values removed

intersection

@Nonnull
public ISet<T> intersection(@Nonnull
 Set<? extends T> otherSet)

Description copied from interface: ISet

Removes all values from the Set that are not contained in the other collection.

Specified by:

intersection in interface ISet<T>

Returns:

instance of set with unmatched values removed

size

public int size()

Specified by:

size in interface ICollection<T>

Returns:

number of values in the collection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ICollection<T>

Returns:

true only if collection contains no values

checkInvariants

public void checkInvariants()

Description copied from interface: InvariantCheckable

Checks invariants of implementing class.

Specified by:

checkInvariants in interface InvariantCheckable

forEach

public void forEach(@Nonnull
 java.util.function.Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

forEachThrows

public <E extends Exception> void forEachThrows(@Nonnull
 Proc1Throws<T,E> proc)
                                         throws E

Description copied from interface: SplitableIterable

Processes every value using the provided function.

Specified by:

forEachThrows in interface SplitableIterable<T>

Throws:

E

iterator

@Nonnull
public SplitableIterator<T> iterator()

Description copied from interface: IStreamable

Overridden here to require implementations to return a SplitableIterator rather than a basic Iterator. This is necessary to allow composition of new objects from methods like keys() and values().

Specified by:

iterator in interface IStreamable<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface SplitableIterable<T>

getSpliteratorCharacteristics

public int getSpliteratorCharacteristics()

Specified by:

getSpliteratorCharacteristics in interface IStreamable<T>

Returns:

characteristics value used when creating Spliterators

mappedContains

public boolean mappedContains(@Nonnull
 ArraySetNode<T> mapping,
 @Nonnull
 T key)

Specified by:

mappedContains in interface ArrayContainsMapper<T,ArraySetNode<T>>

mappedAssign

@Nonnull
public ArraySetNode<T> mappedAssign(@Nonnull
 T key,
 T ignored)

Description copied from interface: ArrayAssignMapper

Called during assign operation to create a new mapping for the given key and value.

Specified by:

mappedAssign in interface ArrayAssignMapper<T,T,ArraySetNode<T>>

Parameters:

key - key being assigned to

ignored - value being assigned

Returns:

non-null mapping

mappedAssign

@Nonnull
public ArraySetNode<T> mappedAssign(@Nonnull
 ArraySetNode<T> current,
 @Nonnull
 T key,
 T ignored)

Description copied from interface: ArrayAssignMapper

Called during assign operation to replace an existing mapping for the given key and value.

Specified by:

mappedAssign in interface ArrayAssignMapper<T,T,ArraySetNode<T>>

Parameters:

current - mapping to be replaced

key - key being assigned to

ignored - value being assigned

Returns:

same to keep mapping or non-null to replace mapping

mappedDelete

@Nullable
public ArraySetNode<T> mappedDelete(@Nonnull
 ArraySetNode<T> current,
 @Nonnull
 T key)

Description copied from interface: ArrayDeleteMapper

Called during delete operation to delete a key from a mapping.

Specified by:

mappedDelete in interface ArrayDeleteMapper<T,ArraySetNode<T>>

Parameters:

current - mapping to be replaced

key - key being deleted

Returns:

null to remove mapping, same to keep mapping, or non-null to replace mapping

mappedSize

public int mappedSize(@Nonnull
 ArraySetNode<T> mapping)

Description copied from interface: ArraySizeMapper

Called to obtain number of keys in a given mapping.

Specified by:

mappedSize in interface ArraySizeMapper<T>

Parameters:

mapping - mapping to be sized

Returns:

number of keys in the mapping

mappedKeys

@Nonnull
public GenericIterator.Iterable<T> mappedKeys(@Nonnull
 ArraySetNode<T> mapping)

Specified by:

mappedKeys in interface ArrayIterationMapper<T,T,ArraySetNode<T>>

mappedValues

@Nonnull
public GenericIterator.Iterable<T> mappedValues(@Nonnull
 ArraySetNode<T> mapping)

Specified by:

mappedValues in interface ArrayIterationMapper<T,T,ArraySetNode<T>>

mappedEntries

@Nonnull
public GenericIterator.Iterable<IMapEntry<T,T>> mappedEntries(@Nonnull
 ArraySetNode<T> mapping)

Specified by:

mappedEntries in interface ArrayIterationMapper<T,T,ArraySetNode<T>>