Eclipse Collections 13.0.0 · org.eclipse.collections.api.set.SetIterable

Modifier and Type	Method and Description
public ParallelSetIterable<T>	asParallel(ExecutorService executorService, int batchSize) Returns a parallel iterable of this SetIterable.
public <B> LazyIterable<Pair<T, B>>	cartesianProduct(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`.
public SetIterable<T>	difference(SetIterable<? extends T> subtrahendSet) Returns the set of all members of `this` that are not members of `subtrahendSet`.
public <R extends Set<T>> R	differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet) Same as `difference(SetIterable)` but adds all the objects to `targetSet` and returns it.
public boolean	equals(Object o) Follows the same general contract as `Set#equals(Object)`.
public int	hashCode() Follows the same general contract as `Set#hashCode()`.
public SetIterable<T>	intersect(SetIterable<? extends T> set) Returns the set of all objects that are members of both `this` and `set`.
public <R extends Set<T>> R	intersectInto(SetIterable<? extends T> set, R targetSet) Same as `intersect(SetIterable)` but adds all the objects to `targetSet` and returns it.
public boolean	isProperSubsetOf(SetIterable<? extends T> candidateSuperset) Returns true if all the members of `this` are also members of `candidateSuperset` and the two sets are not equal.
public boolean	isSubsetOf(SetIterable<? extends T> candidateSuperset) Returns true if all the members of `this` are also members of `candidateSuperset`.
public PartitionSet<T>	partition(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.partition. Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
public <P> PartitionSet<T>	partitionWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.partitionWith. Filters a collection into a PartitionIterable based on the evaluation of the predicate.
public SetIterable<T>	reject(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.reject. Returns all elements of the source collection that return false when evaluating of the predicate.
public <P> SetIterable<T>	rejectWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.rejectWith. Similar to `reject(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
public SetIterable<T>	select(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.select. Returns all elements of the source collection that return true when evaluating the predicate.
public <S> SetIterable<S>	selectInstancesOf(Class<S> clazz) Redeclares org.eclipse.collections.api.RichIterable.selectInstancesOf. Returns all elements of the source collection that are instances of the Class `clazz`.
public <P> SetIterable<T>	selectWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.selectWith. Similar to `select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
public SetIterable<T>	symmetricDifference(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).
public <R extends Set<T>> R	symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet) Same as `symmetricDifference(SetIterable)` but adds all the objects to `targetSet` and returns it.
public SetIterable<T>	tap(Procedure<? super T> procedure) Redeclares org.eclipse.collections.api.RichIterable.tap. Executes the Procedure for each element in the iterable and returns `this`.
public ImmutableSetIterable<T>	toImmutable()
public SetIterable<T>	union(SetIterable<? extends T> set) Returns the set of all objects that are a member of `this` or `set` or both.
public <R extends Set<T>> R	unionInto(SetIterable<? extends T> set, R targetSet) Same as `union(SetIterable)` but adds all the objects to `targetSet` and returns it.
public SetIterable<Pair<T, Integer>>	zipWithIndex() Redeclares org.eclipse.collections.api.RichIterable.zipWithIndex. Deprecated in 6.0. Use `OrderedIterable#zipWithIndex()` instead. Zips this `RichIterable` with its indices.

Method Detail

asParallel	back to summary
public ParallelSetIterable<T> asParallel(ExecutorService executorService, int batchSize) Returns a parallel iterable of this SetIterable. Annotations @Beta Since 6.0

asParallel

back to summary

public ParallelSetIterable<T> asParallel(ExecutorService executorService, int batchSize)

Returns a parallel iterable of this SetIterable.

Annotations

@Beta

Since

6.0

cartesianProduct	back to summary
public <B> LazyIterable<Pair<T, B>> cartesianProduct(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`.

difference	back to summary
public SetIterable<T> difference(SetIterable<? extends T> subtrahendSet) 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].

differenceInto	back to summary
public <R extends Set<T>> R differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet) Same as `difference(SetIterable)` but adds all the objects to `targetSet` and returns it.

equals back to summary

equals	back to summary
public boolean equals(Object o) Follows the same general contract as `Set#equals(Object)`. Annotations @Override

public boolean equals(Object o)

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

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Follows the same general contract as `Set#hashCode()`. Annotations @Override

public int hashCode()

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

Annotations

@Override

intersect back to summary

intersect	back to summary
public SetIterable<T> intersect(SetIterable<? extends T> set) 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 the smaller of the two sets (`this` or `set`) based on the size. If the sizes are equal, the output will contain instances from `this`. Note If you need to ensure that the memory references from `this` are preserved in the resulting set, consider using `this.select(that::contains)` instead.

public SetIterable<T> intersect(SetIterable<? extends T> set)

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 the smaller of the two sets (this or set) based on the size. If the sizes are equal, the output will contain instances from this.

Note

If you need to ensure that the memory references from this are preserved in the resulting set, consider using this.select(that::contains) instead.

intersectInto	back to summary
public <R extends Set<T>> R intersectInto(SetIterable<? extends T> set, R targetSet) Same as `intersect(SetIterable)` but adds all the objects to `targetSet` and returns it.

isProperSubsetOf	back to summary
public boolean isProperSubsetOf(SetIterable<? extends T> candidateSuperset) 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.

isSubsetOf	back to summary
public boolean isSubsetOf(SetIterable<? extends T> candidateSuperset) 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.

partition	back to summary
public PartitionSet<T> partition(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.partition. Doc from org.eclipse.collections.api.RichIterable.partition. 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")); Annotations @Override

partition

back to summary

public PartitionSet<T> partition(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.RichIterable.partition.

Doc from org.eclipse.collections.api.RichIterable.partition.

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"));

Annotations

@Override

partitionWith	back to summary
public <P> PartitionSet<T> partitionWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.partitionWith. Doc from org.eclipse.collections.api.RichIterable.partitionWith. 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"); Annotations @Override

partitionWith

back to summary

public <P> PartitionSet<T> partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.RichIterable.partitionWith.

Doc from org.eclipse.collections.api.RichIterable.partitionWith.

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");

Annotations

@Override

reject	back to summary
public SetIterable<T> reject(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.reject. Doc from org.eclipse.collections.api.RichIterable.reject. 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")); Annotations @Override

reject

back to summary

public SetIterable<T> reject(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.RichIterable.reject.

Doc from org.eclipse.collections.api.RichIterable.reject.

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"));

Annotations

@Override

rejectWith back to summary

rejectWith	back to summary
public <P> SetIterable<T> rejectWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.rejectWith. Doc from org.eclipse.collections.api.RichIterable.rejectWith. Similar to `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)); Annotations @Override

public <P> SetIterable<T> rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.RichIterable.rejectWith.

Doc from org.eclipse.collections.api.RichIterable.rejectWith.

Similar to 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));

Annotations

@Override

select	back to summary
public SetIterable<T> select(Predicate<? super T> predicate) Redeclares org.eclipse.collections.api.RichIterable.select. Doc from org.eclipse.collections.api.RichIterable.select. 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")); Annotations @Override

select

back to summary

public SetIterable<T> select(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.RichIterable.select.

Doc from org.eclipse.collections.api.RichIterable.select.

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"));

Annotations

@Override

selectInstancesOf back to summary

selectInstancesOf	back to summary
public <S> SetIterable<S> selectInstancesOf(Class<S> clazz) Redeclares org.eclipse.collections.api.RichIterable.selectInstancesOf. Doc from org.eclipse.collections.api.RichIterable.selectInstancesOf. Returns all elements of the source collection that are instances of the Class `clazz`. RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class); Annotations @Override

public <S> SetIterable<S> selectInstancesOf(Class<S> clazz)

Redeclares org.eclipse.collections.api.RichIterable.selectInstancesOf.

Doc from org.eclipse.collections.api.RichIterable.selectInstancesOf.

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

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Annotations

@Override

selectWith back to summary

selectWith	back to summary
public <P> SetIterable<T> selectWith(Predicate2<? super T, ? super P> predicate, P parameter) Redeclares org.eclipse.collections.api.RichIterable.selectWith. Doc from org.eclipse.collections.api.RichIterable.selectWith. Similar to `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)); Annotations @Override

public <P> SetIterable<T> selectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.RichIterable.selectWith.

Doc from org.eclipse.collections.api.RichIterable.selectWith.

Similar to 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));

Annotations

@Override

symmetricDifference	back to summary
public SetIterable<T> symmetricDifference(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). 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.

symmetricDifferenceInto	back to summary
public <R extends Set<T>> R symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet) Same as `symmetricDifference(SetIterable)` but adds all the objects to `targetSet` and returns it.

tap back to summary

tap	back to summary
public SetIterable<T> tap(Procedure<? super T> procedure) Redeclares org.eclipse.collections.api.RichIterable.tap. Doc from org.eclipse.collections.api.RichIterable.tap. 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())); Annotations @Override

public SetIterable<T> tap(Procedure<? super T> procedure)

Redeclares org.eclipse.collections.api.RichIterable.tap.

Doc from org.eclipse.collections.api.RichIterable.tap.

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()));

Annotations

@Override

toImmutable	back to summary
public ImmutableSetIterable<T> toImmutable()

union	back to summary
public SetIterable<T> union(SetIterable<? extends T> set) 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`.

unionInto	back to summary
public <R extends Set<T>> R unionInto(SetIterable<? extends T> set, R targetSet) Same as `union(SetIterable)` but adds all the objects to `targetSet` and returns it.

zipWithIndex back to summary

zipWithIndex	back to summary
public SetIterable<Pair<T, Integer>> zipWithIndex() Redeclares org.eclipse.collections.api.RichIterable.zipWithIndex. Doc from org.eclipse.collections.api.RichIterable.zipWithIndex. Deprecated in 6.0. Use `OrderedIterable#zipWithIndex()` instead. Zips this `RichIterable` with its indices. Annotations @Override @Deprecated

public SetIterable<Pair<T, Integer>> zipWithIndex()

Redeclares org.eclipse.collections.api.RichIterable.zipWithIndex.

Doc from org.eclipse.collections.api.RichIterable.zipWithIndex.

Deprecated

in 6.0. Use OrderedIterable#zipWithIndex() instead.

Zips this RichIterable with its indices.

Annotations

@Override
@Deprecated

public Interface SetIterable<T>

Method Summary

Method Detail