com.gs.collections.impl.set.strategy.mutable

Class UnifiedSetWithHashingStrategy<T>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<T>

com.gs.collections.impl.set.AbstractUnifiedSet<T>

com.gs.collections.impl.set.strategy.mutable.UnifiedSetWithHashingStrategy<T>

All Implemented Interfaces:

com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, com.gs.collections.api.set.MutableSet<T>, com.gs.collections.api.set.MutableSetIterable<T>, com.gs.collections.api.set.Pool<T>, com.gs.collections.api.set.SetIterable<T>, com.gs.collections.api.set.UnsortedSetIterable<T>, BatchIterable<T>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

@NotThreadSafe
public class UnifiedSetWithHashingStrategy<T>
extends AbstractUnifiedSet<T>
implements java.io.Externalizable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UnifiedSetWithHashingStrategy.PositionalIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	NULL_KEY
protected int	occupied
protected java.lang.Object[]	table

Fields inherited from class com.gs.collections.impl.set.AbstractUnifiedSet

DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR, loadFactor, maxSize

Constructor Summary

Constructors

Constructor and Description
UnifiedSetWithHashingStrategy() Deprecated. No argument default constructor used for serialization. Instantiating an UnifiedSetWithHashingStrategyMultimap with this constructor will have a null hashingStrategy and throw NullPointerException when used.
UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy)
UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy, java.util.Collection<? extends T> collection)
UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy, int initialCapacity)
UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy, int initialCapacity, float loadFactor)
UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy, UnifiedSetWithHashingStrategy<T> set)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T key)
boolean	addAllIterable(java.lang.Iterable<? extends T> iterable)
protected void	allocateTable(int sizeToAllocate)
com.gs.collections.api.set.ParallelUnsortedSetIterable<T>	asParallel(java.util.concurrent.ExecutorService executorService, int batchSize) Returns a parallel iterable of this SetIterable.
void	batchForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure, int sectionIndex, int sectionCount)
void	clear()
UnifiedSetWithHashingStrategy<T>	clone()
boolean	contains(java.lang.Object key) Returns true if the iterable has an element which responds true to element.equals(object).
protected boolean	copySet(UnifiedSetWithHashingStrategy<?> unifiedset)
protected T	detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, int start, int end)
void	each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) The procedure is executed for each element in the iterable.
boolean	equals(java.lang.Object object) Follows the same general contract as Set.equals(Object).
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
T	get(T key) Locates an object in the pool which is equal to key.
T	getFirst() Returns the first element of an iterable.
T	getLast() Returns the last element of an iterable.
protected java.lang.Object[]	getTable()
<V> UnifiedSetWithHashingStrategyMultimap<V,T>	groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V> UnifiedSetMultimap<V,T>	groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
int	hashCode() Follows the same general contract as Set.hashCode().
com.gs.collections.api.block.HashingStrategy<? super T>	hashingStrategy()
protected int	index(T key)
java.util.Iterator<T>	iterator()
<V> com.gs.collections.api.LazyIterable<V>	lazyCollect(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Deprecated. since 3.0. Use AbstractRichIterable.asLazy().AbstractUnifiedSet.collect(Function) instead.
com.gs.collections.api.LazyIterable<T>	lazyReject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Deprecated. since 3.0. Use AbstractRichIterable.asLazy().reject(Predicate) instead.
com.gs.collections.api.LazyIterable<T>	lazySelect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Deprecated. since 3.0. Use AbstractRichIterable.asLazy().select(Predicate) instead.
UnifiedSetWithHashingStrategy<T>	newEmpty() Creates a new empty mutable version of the same collection type.
static <K> UnifiedSetWithHashingStrategy<K>	newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)
static <K> UnifiedSetWithHashingStrategy<K>	newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int size)
static <K> UnifiedSetWithHashingStrategy<K>	newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int size, float loadFactor)
static <K> UnifiedSetWithHashingStrategy<K>	newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, java.lang.Iterable<? extends K> source)
static <K> UnifiedSetWithHashingStrategy<K>	newSet(UnifiedSetWithHashingStrategy<K> set)
static <K> UnifiedSetWithHashingStrategy<K>	newSetWith(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, K... elements)
com.gs.collections.api.partition.set.PartitionMutableSet<T>	partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> com.gs.collections.api.partition.set.PartitionMutableSet<T>	partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
T	put(T key) Puts key into the pool.
void	readExternal(java.io.ObjectInput in)
protected void	rehash(int newCapacity)
UnifiedSetWithHashingStrategy<T>	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
<P> UnifiedSetWithHashingStrategy<T>	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
boolean	remove(java.lang.Object key)
T	removeFromPool(T key) Locates an object in the pool which is equal to key and removes it.
boolean	retainAllIterable(java.lang.Iterable<?> iterable)
UnifiedSetWithHashingStrategy<T>	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
<P> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>>	selectAndRejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into two separate collections based on a predicate returned via a Pair.
<S> UnifiedSetWithHashingStrategy<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> UnifiedSetWithHashingStrategy<T>	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
protected boolean	shortCircuit(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, boolean expected, boolean onShortCircuit, boolean atEnd, int start, int end)
protected <P> boolean	shortCircuitWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate2, P parameter, boolean expected, boolean onShortCircuit, boolean atEnd)
int	size() Returns the number of items in this iterable.
UnifiedSetWithHashingStrategy<T>	tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Executes the Procedure for each element in the iterable and returns this.
java.lang.Object[]	toArray() Converts this iterable to an array.
<T> T[]	toArray(T[] array) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
com.gs.collections.api.set.ImmutableSet<T>	toImmutable() Returns an immutable copy of this set.
UnifiedSetWithHashingStrategy<T>	with(T... elements)
UnifiedSetWithHashingStrategy<T>	with(T element) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
UnifiedSetWithHashingStrategy<T>	with(T element1, T element2)
UnifiedSetWithHashingStrategy<T>	with(T element1, T element2, T element3)
UnifiedSetWithHashingStrategy<T>	withAll(java.lang.Iterable<? extends T> iterable) This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
UnifiedSetWithHashingStrategy<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
UnifiedSetWithHashingStrategy<T>	withoutAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.gs.collections.impl.set.AbstractUnifiedSet

addAll, aggregateBy, aggregateInPlaceBy, allocate, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asSynchronized, asUnmodifiable, cartesianProduct, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, computeMaxSize, detect, difference, differenceInto, flatCollect, getBatchCount, groupByUniqueKey, init, injectIntoWith, intersect, intersectInto, isProperSubsetOf, isSubsetOf, noneSatisfy, noneSatisfyWith, powerSet, rehash, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, shortCircuit, symmetricDifference, symmetricDifferenceInto, union, unionInto, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gs.collections.api.RichIterable

appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach

Methods inherited from interface java.util.Set

containsAll, isEmpty

Methods inherited from interface com.gs.collections.impl.parallel.BatchIterable

forEach

Field Detail

NULL_KEY

protected static final java.lang.Object NULL_KEY

table

protected transient java.lang.Object[] table

occupied

protected transient int occupied

Constructor Detail

UnifiedSetWithHashingStrategy

@Deprecated
public UnifiedSetWithHashingStrategy()

Deprecated. No argument default constructor used for serialization. Instantiating an UnifiedSetWithHashingStrategyMultimap with this constructor will have a null hashingStrategy and throw NullPointerException when used.

UnifiedSetWithHashingStrategy

public UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy)

UnifiedSetWithHashingStrategy

public UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy,
                             int initialCapacity)

UnifiedSetWithHashingStrategy

public UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy,
                             int initialCapacity,
                             float loadFactor)

UnifiedSetWithHashingStrategy

public UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy,
                             java.util.Collection<? extends T> collection)

UnifiedSetWithHashingStrategy

public UnifiedSetWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy,
                             UnifiedSetWithHashingStrategy<T> set)

Method Detail

newSet

public static <K> UnifiedSetWithHashingStrategy<K> newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)

newSet

public static <K> UnifiedSetWithHashingStrategy<K> newSet(UnifiedSetWithHashingStrategy<K> set)

newSet

public static <K> UnifiedSetWithHashingStrategy<K> newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                          int size)

newSet

public static <K> UnifiedSetWithHashingStrategy<K> newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                          java.lang.Iterable<? extends K> source)

newSet

public static <K> UnifiedSetWithHashingStrategy<K> newSet(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                          int size,
                                          float loadFactor)

newSetWith

public static <K> UnifiedSetWithHashingStrategy<K> newSetWith(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                              K... elements)

hashingStrategy

public com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy()

getTable

protected java.lang.Object[] getTable()

Specified by:

getTable in class AbstractUnifiedSet<T>

allocateTable

protected void allocateTable(int sizeToAllocate)

Specified by:

allocateTable in class AbstractUnifiedSet<T>

index

protected final int index(T key)

clear

public void clear()

Specified by:

clear in interface com.gs.collections.api.set.Pool<T>

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

add

public boolean add(T key)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

rehash

protected void rehash(int newCapacity)

Specified by:

rehash in class AbstractUnifiedSet<T>

contains

public boolean contains(java.lang.Object key)

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface com.gs.collections.api.RichIterable<T>

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

Overrides:

contains in class AbstractRichIterable<T>

batchForEach

public void batchForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure,
                int sectionIndex,
                int sectionCount)

Specified by:

batchForEach in interface BatchIterable<T>

tap

public UnifiedSetWithHashingStrategy<T> tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

Description copied from interface: com.gs.collections.api.RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

 RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

tap in interface com.gs.collections.api.RichIterable<T>

Specified by:

tap in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

tap in interface com.gs.collections.api.set.MutableSetIterable<T>

See Also:

RichIterable.each(Procedure), InternalIterable.forEach(Procedure)

each

public void each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

Description copied from interface: com.gs.collections.api.RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 people.each(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable#forEach(java.util.function.Consumer).

Specified by:

each in interface com.gs.collections.api.RichIterable<T>

See Also:

InternalIterable.forEach(Procedure), Iterable#forEach(java.util.function.Consumer)

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
                   P parameter)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWith in class AbstractRichIterable<T>

forEachWithIndex

public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: com.gs.collections.api.InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWithIndex in class AbstractRichIterable<T>

newEmpty

public UnifiedSetWithHashingStrategy<T> newEmpty()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.

Specified by:

newEmpty in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

newEmpty in interface com.gs.collections.api.set.MutableSet<T>

getFirst

public T getFirst()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

getFirst in interface com.gs.collections.api.RichIterable<T>

getLast

public T getLast()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

getLast in interface com.gs.collections.api.RichIterable<T>

select

public UnifiedSetWithHashingStrategy<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });

Specified by:

select in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

select in interface com.gs.collections.api.RichIterable<T>

Specified by:

select in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

select in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

select in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

select in interface com.gs.collections.api.set.UnsortedSetIterable<T>

selectWith

public <P> UnifiedSetWithHashingStrategy<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                              P parameter)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() >= age;
         }
     }, Integer.valueOf(18));
 

Specified by:

selectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

selectWith in interface com.gs.collections.api.RichIterable<T>

Specified by:

selectWith in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

selectWith in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

selectWith in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

selectWith in interface com.gs.collections.api.set.UnsortedSetIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

reject

public UnifiedSetWithHashingStrategy<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 

Specified by:

reject in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

reject in interface com.gs.collections.api.RichIterable<T>

Specified by:

reject in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

reject in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

reject in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

reject in interface com.gs.collections.api.set.UnsortedSetIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

public <P> UnifiedSetWithHashingStrategy<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                              P parameter)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

rejectWith in interface com.gs.collections.api.RichIterable<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.UnsortedSetIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

selectAndRejectWith

public <P> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>> selectAndRejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                                                                    P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Filters a collection into two separate collections based on a predicate returned via a Pair.

e.g.
 return lastNames.selectAndRejectWith(PredicatesLite.lessThan(), "Mason");
 

Specified by:

selectAndRejectWith in interface com.gs.collections.api.collection.MutableCollection<T>

partition

public com.gs.collections.api.partition.set.PartitionMutableSet<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 

Specified by:

partition in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

partition in interface com.gs.collections.api.RichIterable<T>

Specified by:

partition in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

partition in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

partition in interface com.gs.collections.api.set.SetIterable<T>

partitionWith

public <P> com.gs.collections.api.partition.set.PartitionMutableSet<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                                            P parameter)

Description copied from interface: com.gs.collections.api.RichIterable

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Example using an anonymous inner class:

 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 

Specified by:

partitionWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

partitionWith in interface com.gs.collections.api.RichIterable<T>

Specified by:

partitionWith in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

partitionWith in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

partitionWith in interface com.gs.collections.api.set.SetIterable<T>

selectInstancesOf

public <S> UnifiedSetWithHashingStrategy<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: com.gs.collections.api.RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.RichIterable<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.UnsortedSetIterable<T>

detect

protected T detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
       int start,
       int end)

Specified by:

detect in class AbstractUnifiedSet<T>

shortCircuit

protected boolean shortCircuit(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                   boolean expected,
                   boolean onShortCircuit,
                   boolean atEnd,
                   int start,
                   int end)

Specified by:

shortCircuit in class AbstractUnifiedSet<T>

shortCircuitWith

protected <P> boolean shortCircuitWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate2,
                           P parameter,
                           boolean expected,
                           boolean onShortCircuit,
                           boolean atEnd)

Specified by:

shortCircuitWith in class AbstractUnifiedSet<T>

lazySelect

@Deprecated
public com.gs.collections.api.LazyIterable<T> lazySelect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Deprecated. since 3.0. Use AbstractRichIterable.asLazy().select(Predicate) instead.

lazyReject

@Deprecated
public com.gs.collections.api.LazyIterable<T> lazyReject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Deprecated. since 3.0. Use AbstractRichIterable.asLazy().reject(Predicate) instead.

lazyCollect

@Deprecated
public <V> com.gs.collections.api.LazyIterable<V> lazyCollect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Deprecated. since 3.0. Use AbstractRichIterable.asLazy().AbstractUnifiedSet.collect(Function) instead.

toImmutable

public com.gs.collections.api.set.ImmutableSet<T> toImmutable()

Description copied from interface: com.gs.collections.api.set.MutableSet

Returns an immutable copy of this set. If the set is immutable, it returns itself.

The returned set will be Serializable if this set is Serializable.

Specified by:

toImmutable in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

toImmutable in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

toImmutable in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

toImmutable in interface com.gs.collections.api.set.UnsortedSetIterable<T>

with

public UnifiedSetWithHashingStrategy<T> with(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.with("1");
 list = list.with("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.

Specified by:

with in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

with in interface com.gs.collections.api.set.MutableSet<T>

See Also:

Collection.add(Object)

with

public UnifiedSetWithHashingStrategy<T> with(T element1,
                                    T element2)

with

public UnifiedSetWithHashingStrategy<T> with(T element1,
                                    T element2,
                                    T element3)

with

public UnifiedSetWithHashingStrategy<T> with(T... elements)

withAll

public UnifiedSetWithHashingStrategy<T> withAll(java.lang.Iterable<? extends T> iterable)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.

Specified by:

withAll in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

withAll in interface com.gs.collections.api.set.MutableSet<T>

See Also:

Collection.addAll(Collection)

without

public UnifiedSetWithHashingStrategy<T> without(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.without("1");
 list = list.without("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.

Specified by:

without in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

without in interface com.gs.collections.api.set.MutableSet<T>

See Also:

Collection.remove(Object)

withoutAll

public UnifiedSetWithHashingStrategy<T> withoutAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.

Specified by:

withoutAll in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

withoutAll in interface com.gs.collections.api.set.MutableSet<T>

See Also:

Collection.removeAll(Collection)

addAllIterable

public boolean addAllIterable(java.lang.Iterable<? extends T> iterable)

Specified by:

addAllIterable in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.addAll(Collection)

copySet

protected boolean copySet(UnifiedSetWithHashingStrategy<?> unifiedset)

remove

public boolean remove(java.lang.Object key)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

size

public int size()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface com.gs.collections.api.RichIterable<T>

Specified by:

size in interface com.gs.collections.api.set.Pool<T>

Specified by:

size in interface BatchIterable<T>

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Set<T>

equals

public boolean equals(java.lang.Object object)

Description copied from interface: com.gs.collections.api.set.SetIterable

Follows the same general contract as Set.equals(Object).

Specified by:

equals in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.Set<T>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.set.SetIterable

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.Set<T>

Overrides:

hashCode in class java.lang.Object

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

retainAllIterable

public boolean retainAllIterable(java.lang.Iterable<?> iterable)

Specified by:

retainAllIterable in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.retainAll(Collection)

clone

public UnifiedSetWithHashingStrategy<T> clone()

Specified by:

clone in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

clone in class AbstractUnifiedSet<T>

toArray

public java.lang.Object[] toArray()

Description copied from interface: com.gs.collections.api.RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface com.gs.collections.api.RichIterable<T>

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

toArray

public <T> T[] toArray(T[] array)

Description copied from interface: com.gs.collections.api.RichIterable

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

toArray in interface com.gs.collections.api.RichIterable<T>

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray(Object[])

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

groupBy

public <V> UnifiedSetWithHashingStrategyMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Description copied from interface: com.gs.collections.api.RichIterable

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 

Example using an anonymous inner class:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String value(Person person)
         {
             return person.getLastName();
         }
     });
 

Specified by:

groupBy in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

groupBy in interface com.gs.collections.api.RichIterable<T>

Specified by:

groupBy in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

groupBy in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

groupBy in interface com.gs.collections.api.set.UnsortedSetIterable<T>

groupByEach

public <V> UnifiedSetMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

groupByEach in interface com.gs.collections.api.RichIterable<T>

Specified by:

groupByEach in interface com.gs.collections.api.set.MutableSet<T>

Specified by:

groupByEach in interface com.gs.collections.api.set.MutableSetIterable<T>

Specified by:

groupByEach in interface com.gs.collections.api.set.UnsortedSetIterable<T>

Overrides:

groupByEach in class AbstractUnifiedSet<T>

get

public T get(T key)

Description copied from interface: com.gs.collections.api.set.Pool

Locates an object in the pool which is equal to key.

Specified by:

get in interface com.gs.collections.api.set.Pool<T>

Parameters:

key - the value to look for

Returns:

The object reference in the pool equal to key or null.

put

public T put(T key)

Description copied from interface: com.gs.collections.api.set.Pool

Puts key into the pool. If there is no existing object that is equal to key, key will be added to the pool and the return value will be the same instance. If there is an existing object in the pool that is equal to key, the pool will remain unchanged and the pooled instance will be is returned.

Specified by:

put in interface com.gs.collections.api.set.Pool<T>

Parameters:

key - the value to add if not in the pool

Returns:

the object reference in the pool equal to key (either key itself or the existing reference)

removeFromPool

public T removeFromPool(T key)

Description copied from interface: com.gs.collections.api.set.Pool

Locates an object in the pool which is equal to key and removes it.

Specified by:

removeFromPool in interface com.gs.collections.api.set.Pool<T>

Parameters:

key - object to remove

Returns:

The object reference in the pool equal to key or null.

asParallel

public com.gs.collections.api.set.ParallelUnsortedSetIterable<T> asParallel(java.util.concurrent.ExecutorService executorService,
                                                                   int batchSize)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns a parallel iterable of this SetIterable.

Specified by:

asParallel in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

asParallel in interface com.gs.collections.api.set.UnsortedSetIterable<T>