org.eclipse.collections.api.collection.MutableCollection Maven / Gradle / Ivy
/*
* Copyright (c) 2021 Goldman Sachs and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api.collection;
import java.util.Collection;
import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.bag.MutableBag;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.Function3;
import org.eclipse.collections.api.block.function.primitive.BooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.function.primitive.ShortFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.Procedure2;
import org.eclipse.collections.api.collection.primitive.MutableBooleanCollection;
import org.eclipse.collections.api.collection.primitive.MutableByteCollection;
import org.eclipse.collections.api.collection.primitive.MutableCharCollection;
import org.eclipse.collections.api.collection.primitive.MutableDoubleCollection;
import org.eclipse.collections.api.collection.primitive.MutableFloatCollection;
import org.eclipse.collections.api.collection.primitive.MutableIntCollection;
import org.eclipse.collections.api.collection.primitive.MutableLongCollection;
import org.eclipse.collections.api.collection.primitive.MutableShortCollection;
import org.eclipse.collections.api.factory.Maps;
import org.eclipse.collections.api.factory.primitive.BooleanLists;
import org.eclipse.collections.api.factory.primitive.ByteLists;
import org.eclipse.collections.api.factory.primitive.CharLists;
import org.eclipse.collections.api.factory.primitive.DoubleLists;
import org.eclipse.collections.api.factory.primitive.FloatLists;
import org.eclipse.collections.api.factory.primitive.IntLists;
import org.eclipse.collections.api.factory.primitive.LongLists;
import org.eclipse.collections.api.factory.primitive.ShortLists;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.map.primitive.MutableObjectDoubleMap;
import org.eclipse.collections.api.map.primitive.MutableObjectLongMap;
import org.eclipse.collections.api.multimap.MutableMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.PartitionMutableCollection;
import org.eclipse.collections.api.tuple.Pair;
import org.eclipse.collections.api.tuple.Twin;
/**
* MutableCollection is an interface which extends the base java.util.Collection interface and adds several internal
* iterator methods, from the Smalltalk Collection protocol. These include variations of forEach, select, reject,
* detect, collect, injectInto, anySatisfy, allSatisfy. These include count, remove, partition, collectIf. The API also
* includes converter methods to convert a MutableCollection to a List (toList), to a sorted List (toSortedList), to a
* Set (toSet), and to a Map (toMap).
*
* There are several extensions to MutableCollection, including MutableList, MutableSet, and MutableBag.
*/
public interface MutableCollection
extends Collection, RichIterable
{
/**
* 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;
*
* In the case of {@link 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.
*
* @see #add(Object)
*/
MutableCollection with(T element);
/**
* 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;
*
* In the case of {@link 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.
*
* @see #remove(Object)
*/
MutableCollection without(T element);
/**
* 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"));
*
* In the case of {@link 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.
*
* @see #addAll(Collection)
*/
MutableCollection withAll(Iterable elements);
/**
* 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"));
*
* In the case of {@link 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.
*
* @see #removeAll(Collection)
*/
MutableCollection withoutAll(Iterable elements);
/**
* 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.
*/
MutableCollection newEmpty();
@Override
MutableCollection tap(Procedure procedure);
/**
* 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"));
*
*/
@Override
MutableCollection select(Predicate predicate);
/**
* 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));
*
*/
@Override
MutableCollection selectWith(Predicate2 predicate, P parameter);
/**
* 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"));
*
* Using the {@code Predicates} factory:
*
*
* MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
*
*/
@Override
MutableCollection reject(Predicate predicate);
/**
* 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));
*
*/
@Override
MutableCollection rejectWith(Predicate2 predicate, P parameter);
/**
* Filters a collection into two separate collections based on a predicate returned via a Pair.
*
* e.g.
* return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason");
*
*
* @deprecated since 6.0 use {@link RichIterable#partitionWith(Predicate2, Object)} instead.
*/
@Deprecated
Twin> selectAndRejectWith(Predicate2 predicate, P parameter);
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
* people.partition(person -> person.getAddress().getState().getName().equals("New York"));
*
*/
@Override
PartitionMutableCollection partition(Predicate predicate);
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
* people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
*
*/
@Override
PartitionMutableCollection partitionWith(Predicate2 predicate, P parameter);
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableCollection<Integer> integers =
* List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
*
*
* @since 2.0
*/
@Override
MutableCollection selectInstancesOf(Class clazz);
/**
* Removes all elements in the collection that evaluate to true for the specified predicate.
*
* e.g.
* return lastNames.removeIf(Predicates.isNull());
*
*/
boolean removeIf(Predicate predicate);
/**
* Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
*
*
* return lastNames.removeIfWith(Predicates2.isNull(), null);
*
*/
boolean removeIfWith(Predicate2 predicate, P parameter);
/**
* Returns a new MutableCollection with the results of applying the specified function to each element of the source
* collection.
*
*
* MutableCollection<String> names =
* people.collect(person -> person.getFirstName() + " " + person.getLastName());
*
*/
@Override
MutableCollection collect(Function function);
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableBooleanCollection licenses =
* people.collectBoolean(person -> person.hasDrivingLicense());
*
*/
@Override
default MutableBooleanCollection collectBoolean(BooleanFunction booleanFunction)
{
return this.collectBoolean(booleanFunction, BooleanLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableByteCollection bytes =
* people.collectByte(person -> person.getCode());
*
*/
@Override
default MutableByteCollection collectByte(ByteFunction byteFunction)
{
return this.collectByte(byteFunction, ByteLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableCharCollection chars =
* people.collectChar(person -> person.getMiddleInitial());
*
*/
@Override
default MutableCharCollection collectChar(CharFunction charFunction)
{
return this.collectChar(charFunction, CharLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableDoubleCollection doubles =
* people.collectDouble(person -> person.getMilesFromNorthPole());
*
*/
@Override
default MutableDoubleCollection collectDouble(DoubleFunction doubleFunction)
{
return this.collectDouble(doubleFunction, DoubleLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableFloatCollection floats =
* people.collectFloat(person -> person.getHeightInInches());
*
*/
@Override
default MutableFloatCollection collectFloat(FloatFunction floatFunction)
{
return this.collectFloat(floatFunction, FloatLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableIntCollection ints =
* people.collectInt(person -> person.getAge());
*
*/
@Override
default MutableIntCollection collectInt(IntFunction intFunction)
{
return this.collectInt(intFunction, IntLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableLongCollection longs =
* people.collectLong(person -> person.getGuid());
*
*/
@Override
default MutableLongCollection collectLong(LongFunction longFunction)
{
return this.collectLong(longFunction, LongLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableShortCollection shorts =
* people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
*
*/
@Override
default MutableShortCollection collectShort(ShortFunction shortFunction)
{
return this.collectShort(shortFunction, ShortLists.mutable.withInitialCapacity(this.size()));
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableCollection<Integer> integers =
* Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
*
*/
@Override
MutableCollection collectWith(Function2 function, P parameter);
/**
* Returns a new MutableCollection with the results of applying the specified function to each element of the source
* collection, but only for elements that evaluate to true for the specified predicate.
*
*
* MutableCollection<String> collected =
* Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
*
*/
@Override
MutableCollection collectIf(Predicate predicate, Function function);
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* Function<Person, List<Address>> addressFunction = Person::getAddresses;
* MutableCollection<Person> people = ...;
* MutableCollection<List<Address>> addresses = people.collect(addressFunction);
* MutableCollection<Address> addresses = people.flatCollect(addressFunction);
*
*
* @param function The {@link Function} to apply
* @return a new flattened collection produced by applying the given {@code function}
* @since 1.0
*/
@Override
MutableCollection flatCollect(Function> function);
/**
* @since 9.2
*/
@Override
default MutableCollection flatCollectWith(Function2> function, P parameter)
{
return this.flatCollect(each -> function.apply(each, parameter));
}
/**
* Returns the final result of evaluating function using each element of the iterable, the previous evaluation
* result and the parameters. The injected value is used for the first parameter of the first evaluation, and the current
* item in the iterable is used as the second parameter. The parameter value is always used as the third parameter
* to the function call.
*
* @see #injectInto(Object, Function2)
*/
IV injectIntoWith(
IV injectValue,
Function3 function,
P parameter);
/**
* Returns an unmodifiable view of this collection. This is the equivalent of using
* {@code Collections.unmodifiableCollection(this)} with a return type that supports the full
* iteration protocols available on {@code MutableCollection}. Methods which would
* mutate the underlying collection will throw UnsupportedOperationExceptions.
*
* @return an unmodifiable view of this collection.
* @see java.util.Collections#unmodifiableCollection(Collection)
* @since 1.0
*/
MutableCollection asUnmodifiable();
/**
* Returns a synchronized wrapper backed by this collection. This is the equivalent of using
* {@code Collections.synchronizedCollection(this)} only with a return type that supports the full
* iteration protocols available on {@code MutableCollection}.
*
* The preferred way of iterating over a synchronized collection is to use the internal iteration
* methods which are properly synchronized internally.
*
*
* MutableCollection synchedCollection = collection.asSynchronized();
* ...
* synchedCollection.forEach(each -> ... );
* synchedCollection.select(each -> ... );
* synchedCollection.collect(each -> ... );
*
*
* If you want to iterate using an imperative style, you must protect external iterators using
* a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.
*
*
* @return a synchronized view of this collection.
* @see java.util.Collections#synchronizedCollection(Collection)
* @since 1.0
*/
MutableCollection asSynchronized();
/**
* Converts this {@code MutableCollection} to an {@code ImmutableCollection}.
*
* @since 1.0
*/
ImmutableCollection toImmutable();
@Override
MutableObjectLongMap sumByInt(Function groupBy, IntFunction function);
@Override
MutableObjectDoubleMap sumByFloat(Function groupBy, FloatFunction function);
@Override
MutableObjectLongMap sumByLong(Function groupBy, LongFunction function);
@Override
MutableObjectDoubleMap sumByDouble(Function groupBy, DoubleFunction function);
/**
* @since 9.0
*/
@Override
default MutableBag countBy(Function function)
{
return this.asLazy().collect(function).toBag();
}
/**
* @since 9.0
*/
@Override
default MutableBag countByWith(Function2 function, P parameter)
{
return this.asLazy().collectWith(function, parameter).toBag();
}
/**
* @since 10.0.0
*/
@Override
default MutableBag countByEach(Function> function)
{
return this.asLazy().flatCollect(function).toBag();
}
/**
* {@inheritDoc}
* Co-variant example for MutableCollection:
*
* MutableMultimap<String, Person> peopleByLastName =
* people.groupBy(Person::getLastName);
*
*/
@Override
MutableMultimap groupBy(Function function);
@Override
MutableMultimap groupByEach(Function> function);
@Override
default MutableMap groupByUniqueKey(Function function)
{
return this.groupByUniqueKey(function, Maps.mutable.withInitialCapacity(this.size()));
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
MutableCollection> zip(Iterable that);
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
MutableCollection> zipWithIndex();
/**
* @see #addAll(Collection)
* @since 1.0
*/
boolean addAllIterable(Iterable iterable);
/**
* @see #removeAll(Collection)
* @since 1.0
*/
boolean removeAllIterable(Iterable iterable);
/**
* @see #retainAll(Collection)
* @since 1.0
*/
boolean retainAllIterable(Iterable iterable);
@Override
default MutableMap aggregateInPlaceBy(
Function groupBy,
Function0 zeroValueFactory,
Procedure2 mutatingAggregator)
{
MutableMap map = Maps.mutable.empty();
this.forEach(each ->
{
K key = groupBy.valueOf(each);
V value = map.getIfAbsentPut(key, zeroValueFactory);
mutatingAggregator.value(value, each);
});
return map;
}
@Override
default MutableMap aggregateBy(
Function groupBy,
Function0 zeroValueFactory,
Function2 nonMutatingAggregator)
{
return this.aggregateBy(
groupBy,
zeroValueFactory,
nonMutatingAggregator,
Maps.mutable.empty());
}
}