com.gs.collections.impl.set.mutable

Class MultiReaderUnifiedSet<T>

java.lang.Object

com.gs.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection<T>

com.gs.collections.impl.set.mutable.MultiReaderUnifiedSet<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.SetIterable<T>, com.gs.collections.api.set.UnsortedSetIterable<T>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.RandomAccess, java.util.Set<T>

public final class MultiReaderUnifiedSet<T>
extends AbstractMultiReaderMutableCollection<T>
implements java.util.RandomAccess, java.io.Externalizable, com.gs.collections.api.set.MutableSet<T>

MultiReadUnifiedSet provides a thread-safe wrapper around a UnifiedSet, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderFastList does not implement iterator() as all this method requires an external lock to be taken to provide thread-safe iteration. You can use an iterator() if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure, and a wrapped version of the underlying Unified is returned. This wrapper guarantees that no external pointer can ever reference the underlying UnifiedSet outside of a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gs.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection

AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

Constructor Summary

Constructors

Constructor and Description
MultiReaderUnifiedSet()

Method Summary

Methods

Modifier and Type	Method and Description
com.gs.collections.api.set.MutableSet<T>	asSynchronized() Returns a synchronized (thread-safe) collection backed by this collection.
com.gs.collections.api.set.MutableSet<T>	asUnmodifiable() Returns an unmodifable view of the set.
<B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>>	cartesianProduct(com.gs.collections.api.set.SetIterable<B> set) Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>	chunk(int size) Partitions elements in fixed size chunks.
com.gs.collections.api.set.MutableSet<T>	clone()
<V> com.gs.collections.api.set.MutableSet<V>	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableBooleanSet	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction) Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableByteSet	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction) Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableCharSet	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction) Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableDoubleSet	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction) Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableFloatSet	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction) Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> com.gs.collections.api.set.MutableSet<V>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
com.gs.collections.api.set.primitive.MutableIntSet	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction) Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableLongSet	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction) Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.MutableShortSet	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction) Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> com.gs.collections.api.set.MutableSet<V>	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the block
com.gs.collections.api.set.MutableSet<T>	difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet) Returns the set of all members of this that are not members of subtrahendSet.
<R extends java.util.Set<T>> R	differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet, R targetSet) Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
boolean	equals(java.lang.Object o) Follows the same general contract as Set.equals(Object).
<V> com.gs.collections.api.set.MutableSet<V>	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
protected com.gs.collections.api.set.MutableSet<T>	getDelegate()
protected java.util.concurrent.locks.ReadWriteLock	getLock()
<V> com.gs.collections.api.multimap.set.MutableSetMultimap<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> com.gs.collections.api.multimap.set.MutableSetMultimap<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.
<V> com.gs.collections.api.map.MutableMap<V,T>	groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode() Follows the same general contract as Set.hashCode().
com.gs.collections.api.set.MutableSet<T>	intersect(com.gs.collections.api.set.SetIterable<? extends T> set) Returns the set of all objects that are members of both this and set.
<R extends java.util.Set<T>> R	intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
boolean	isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset) Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal.
boolean	isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset) Returns true if all the members of this are also members of candidateSuperset.
com.gs.collections.api.set.MutableSet<T>	newEmpty() Creates a new empty mutable version of the same collection type.
static <T> MultiReaderUnifiedSet<T>	newSet()
static <T> MultiReaderUnifiedSet<T>	newSet(int capacity)
static <T> MultiReaderUnifiedSet<T>	newSet(java.lang.Iterable<T> iterable)
static <T> MultiReaderUnifiedSet<T>	newSetWith(T... 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.
com.gs.collections.api.set.MutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>>	powerSet() Returns the set whose members are all possible subsets of this.
void	readExternal(java.io.ObjectInput in)
com.gs.collections.api.set.MutableSet<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> com.gs.collections.api.set.MutableSet<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.
com.gs.collections.api.set.MutableSet<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.
<S> com.gs.collections.api.set.MutableSet<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> com.gs.collections.api.set.MutableSet<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.
com.gs.collections.api.set.MutableSet<T>	symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB) Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both).
<R extends java.util.Set<T>> R	symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
com.gs.collections.api.set.ImmutableSet<T>	toImmutable() Returns an immutable copy of this set.
com.gs.collections.api.set.MutableSet<T>	union(com.gs.collections.api.set.SetIterable<? extends T> set) Returns the set of all objects that are a member of this or set or both.
<R extends java.util.Set<T>> R	unionInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
com.gs.collections.api.set.MutableSet<T>	with(T element) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
com.gs.collections.api.set.MutableSet<T>	withAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
com.gs.collections.api.set.MutableSet<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
com.gs.collections.api.set.MutableSet<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	withReadLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.set.MutableSet<T>> procedure)
void	withWriteLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.set.MutableSet<T>> procedure)
void	writeExternal(java.io.ObjectOutput out)
<S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection

acquireReadLock, acquireWriteLock, add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, unlockReadLock, unlockWriteLock, withReadLockRun, 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

aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface com.gs.collections.api.collection.MutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

MultiReaderUnifiedSet

public MultiReaderUnifiedSet()

Method Detail

newSet

public static <T> MultiReaderUnifiedSet<T> newSet()

newSet

public static <T> MultiReaderUnifiedSet<T> newSet(int capacity)

newSet

public static <T> MultiReaderUnifiedSet<T> newSet(java.lang.Iterable<T> iterable)

newSetWith

public static <T> MultiReaderUnifiedSet<T> newSetWith(T... elements)

getDelegate

protected com.gs.collections.api.set.MutableSet<T> getDelegate()

Specified by:

getDelegate in class AbstractMultiReaderMutableCollection<T>

getLock

protected java.util.concurrent.locks.ReadWriteLock getLock()

Specified by:

getLock in class AbstractMultiReaderMutableCollection<T>

withReadLockAndDelegate

public void withReadLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.set.MutableSet<T>> procedure)

withWriteLockAndDelegate

public void withWriteLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.set.MutableSet<T>> procedure)

asSynchronized

public com.gs.collections.api.set.MutableSet<T> asSynchronized()

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

Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.

It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.

  MutableCollection collection = myCollection.asSynchronized();
     ...
  synchronized(collection)
  {
      Iterator i = c.iterator(); // Must be in the synchronized block
      while (i.hasNext())
         foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableCollection collection = myCollection.asSynchronized();
     ...
  collection.forEach(new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if this collection is serializable.

Specified by:

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

Specified by:

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

Returns:

a synchronized view of this collection.

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.UnsortedSetIterable<T>

asUnmodifiable

public com.gs.collections.api.set.MutableSet<T> asUnmodifiable()

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

Returns an unmodifable view of the set. The returned set will be Serializable if this set is Serializable.

Specified by:

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

Specified by:

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

Returns:

an unmodifiable view of this set

clone

public com.gs.collections.api.set.MutableSet<T> clone()

Specified by:

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

Overrides:

clone in class java.lang.Object

collect

public <V> com.gs.collections.api.set.MutableSet<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectBoolean

public com.gs.collections.api.set.primitive.MutableBooleanSet collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)

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

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectByte

public com.gs.collections.api.set.primitive.MutableByteSet collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)

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

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectChar

public com.gs.collections.api.set.primitive.MutableCharSet collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)

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

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectDouble

public com.gs.collections.api.set.primitive.MutableDoubleSet collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)

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

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectFloat

public com.gs.collections.api.set.primitive.MutableFloatSet collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)

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

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectInt

public com.gs.collections.api.set.primitive.MutableIntSet collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)

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

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectLong

public com.gs.collections.api.set.primitive.MutableLongSet collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)

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

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectShort

public com.gs.collections.api.set.primitive.MutableShortSet collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)

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

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

flatCollect

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

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

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>()
 {
     public List<Address> valueOf(Person person)
     {
         return person.getAddresses();
     }
 };
 MutableList<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 MutableList<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 MutableList<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectIf

public <V> com.gs.collections.api.set.MutableSet<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                     com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).

e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

collectWith

public <P,V> com.gs.collections.api.set.MutableSet<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
                                                         P parameter)

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

Same as collect with a Function2 and specified parameter which is passed to the block

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

RichIterable.collect(Function)

newEmpty

public com.gs.collections.api.set.MutableSet<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>

reject

public com.gs.collections.api.set.MutableSet<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)).

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

e.g.
 return people.reject(Predicates.attributeEqual("lastName", "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.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> com.gs.collections.api.set.MutableSet<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.

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.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)

select

public com.gs.collections.api.set.MutableSet<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.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

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.SetIterable<T>

Specified by:

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

selectWith

public <P> com.gs.collections.api.set.MutableSet<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.

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.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)

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.

e.g.
 return 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.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.

e.g.
 return 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.SetIterable<T>

selectInstancesOf

public <S> com.gs.collections.api.set.MutableSet<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.SetIterable<T>

Specified by:

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

with

public com.gs.collections.api.set.MutableSet<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)

without

public com.gs.collections.api.set.MutableSet<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)

withAll

public com.gs.collections.api.set.MutableSet<T> withAll(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 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)

withoutAll

public com.gs.collections.api.set.MutableSet<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)

equals

public boolean equals(java.lang.Object o)

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

writeExternal

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

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

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

groupBy

public <V> com.gs.collections.api.multimap.set.MutableSetMultimap<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.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + 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.UnsortedSetIterable<T>

groupByEach

public <V> com.gs.collections.api.multimap.set.MutableSetMultimap<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.UnsortedSetIterable<T>

groupByUniqueKey

public <V> com.gs.collections.api.map.MutableMap<V,T> groupByUniqueKey(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 he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

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

Specified by:

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

See Also:

RichIterable.groupBy(Function)

zip

public <S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)

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

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

public com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()

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

Zips this RichIterable with its indices.

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

chunk

public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>> chunk(int size)

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

Partitions elements in fixed size chunks.

Specified by:

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

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

union

public com.gs.collections.api.set.MutableSet<T> union(com.gs.collections.api.set.SetIterable<? extends T> set)

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

Returns the set of all objects that are a member of this or set or both. The union of [1, 2, 3] and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the copy from this.

Specified by:

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

Specified by:

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

Specified by:

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

unionInto

public <R extends java.util.Set<T>> R unionInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                       R targetSet)

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

Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

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

intersect

public com.gs.collections.api.set.MutableSet<T> intersect(com.gs.collections.api.set.SetIterable<? extends T> set)

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

Returns the set of all objects that are members of both this and set. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from this, not set.

Specified by:

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

Specified by:

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

Specified by:

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

intersectInto

public <R extends java.util.Set<T>> R intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                           R targetSet)

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

Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

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

difference

public com.gs.collections.api.set.MutableSet<T> difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)

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

Returns the set of all members of this that are not members of subtrahendSet. The difference of [1, 2, 3] and [2, 3, 4] is [1].

Specified by:

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

Specified by:

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

Specified by:

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

differenceInto

public <R extends java.util.Set<T>> R differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet,
                                            R targetSet)

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

Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

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

symmetricDifference

public com.gs.collections.api.set.MutableSet<T> symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)

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

Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both). For instance, for the sets [1, 2, 3] and [2, 3, 4], the symmetric difference set is [1, 4] . It is the set difference of the union and the intersection.

Specified by:

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

Specified by:

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

Specified by:

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

symmetricDifferenceInto

public <R extends java.util.Set<T>> R symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                                     R targetSet)

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

Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

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

isSubsetOf

public boolean isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)

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

Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.

Specified by:

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

isProperSubsetOf

public boolean isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)

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

Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.

Specified by:

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

powerSet

public com.gs.collections.api.set.MutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> powerSet()

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

Returns the set whose members are all possible subsets of this. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].

Specified by:

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

Specified by:

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

cartesianProduct

public <B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> cartesianProduct(com.gs.collections.api.set.SetIterable<B> set)

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

Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.

Specified by:

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