public Interface MutableSetIterable<T>

Redeclares org.eclipse.collections.api.RichIterable.groupBy, org.eclipse.collections.api.collection.MutableCollection.groupBy.

Doc from org.eclipse.collections.api.collection.MutableCollection.groupBy.

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

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

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.groupByEach, org.eclipse.collections.api.collection.MutableCollection.groupByEach.

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

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

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.partition, org.eclipse.collections.api.collection.MutableCollection.partition.

Doc from org.eclipse.collections.api.collection.MutableCollection.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"));

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

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.partitionWith, org.eclipse.collections.api.collection.MutableCollection.partitionWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.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");

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

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.reject, org.eclipse.collections.api.collection.MutableCollection.reject.

Doc from org.eclipse.collections.api.collection.MutableCollection.reject.

Returns a MutableCollection with all elements that evaluate to false for the specified predicate.

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

MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.rejectWith, org.eclipse.collections.api.collection.MutableCollection.rejectWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.rejectWith.

Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.

e.g.
MutableCollection<Integer> selected =
    integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.select, org.eclipse.collections.api.collection.MutableCollection.select.

Doc from org.eclipse.collections.api.collection.MutableCollection.select.

Returns a MutableCollection with all elements that evaluate to true for the specified predicate.

MutableCollection<Integer> livesInLondon =
    people.select(person -> person.getAddress().getCity().equals("London"));

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.selectInstancesOf, org.eclipse.collections.api.collection.MutableCollection.selectInstancesOf.

Doc from org.eclipse.collections.api.collection.MutableCollection.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);

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

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.selectWith, org.eclipse.collections.api.collection.MutableCollection.selectWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.selectWith.

Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.

MutableCollection<Integer> fives =
    integers.selectWith(Predicates2.equal(), Integer.valueOf(5));

Annotations

@Override

Redeclares org.eclipse.collections.api.set.SetIterable.tap, org.eclipse.collections.api.collection.MutableCollection.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

Overrides default org.eclipse.collections.api.RichIterable.toArray, org.eclipse.collections.api.collection.MutableCollection.toArray.

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Annotations

@Override

Overrides default org.eclipse.collections.api.RichIterable.toArray, org.eclipse.collections.api.collection.MutableCollection.toArray.

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.with.

Doc from org.eclipse.collections.api.collection.MutableCollection.with.

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<String> list = list.with("1");
list = list.with("2");
return list;

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.withAll.

Doc from org.eclipse.collections.api.collection.MutableCollection.withAll.

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<String> list = list.withAll(FastList.newListWith("1", "2"));

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.without.

Doc from org.eclipse.collections.api.collection.MutableCollection.without.

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 containing 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<String> list = list.without("1");
list = list.without("2");
return list;

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.withoutAll.

Doc from org.eclipse.collections.api.collection.MutableCollection.withoutAll.

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 containing 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<String> list = list.withoutAll(FastList.newListWith("1", "2"));

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.zip, org.eclipse.collections.api.collection.MutableCollection.zip.

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

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.

Annotations

@Override

@Deprecated

Redeclares org.eclipse.collections.api.set.SetIterable.zipWithIndex, org.eclipse.collections.api.collection.MutableCollection.zipWithIndex.

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

Zips this RichIterable with its indices.

Annotations

@Override

@Deprecated