
org.eclipse.collections.api.bag.MutableBag Maven / Gradle / Ivy
/*
* Copyright (c) 2016 Goldman Sachs.
* 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.bag;
import org.eclipse.collections.api.bag.primitive.MutableBooleanBag;
import org.eclipse.collections.api.bag.primitive.MutableByteBag;
import org.eclipse.collections.api.bag.primitive.MutableCharBag;
import org.eclipse.collections.api.bag.primitive.MutableDoubleBag;
import org.eclipse.collections.api.bag.primitive.MutableFloatBag;
import org.eclipse.collections.api.bag.primitive.MutableIntBag;
import org.eclipse.collections.api.bag.primitive.MutableLongBag;
import org.eclipse.collections.api.bag.primitive.MutableShortBag;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
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.predicate.primitive.IntPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.multimap.bag.MutableBagMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionMutableBag;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.tuple.Pair;
/**
* A MutableBag is a Collection whose elements are unordered and may contain duplicate entries. It varies from
* MutableCollection in that it adds a protocol for determining, adding, and removing the number of occurrences for an
* item.
*
* @since 1.0
*/
public interface MutableBag
extends UnsortedBag, MutableBagIterable
{
@Override
MutableMap toMapOfItemToCount();
@Override
MutableBag selectByOccurrences(IntPredicate predicate);
@Override
MutableBag with(T element);
@Override
MutableBag without(T element);
@Override
MutableBag withAll(Iterable extends T> elements);
@Override
MutableBag withoutAll(Iterable extends T> elements);
@Override
MutableBag newEmpty();
@Override
MutableBag asUnmodifiable();
@Override
MutableBag asSynchronized();
@Override
PartitionMutableBag partition(Predicate super T> predicate);
@Override
PartitionMutableBag partitionWith(Predicate2 super T, ? super P> predicate, P parameter);
@Override
MutableBagMultimap groupBy(Function super T, ? extends V> function);
@Override
MutableBagMultimap groupByEach(Function super T, ? extends Iterable> function);
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
MutableBag> zip(Iterable that);
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
MutableSet> zipWithIndex();
@Override
MutableBag tap(Procedure super T> procedure);
@Override
MutableBag select(Predicate super T> predicate);
@Override
MutableBag selectWith(Predicate2 super T, ? super P> predicate, P parameter);
@Override
MutableBag reject(Predicate super T> predicate);
@Override
MutableBag rejectWith(Predicate2 super T, ? super P> predicate, P parameter);
@Override
MutableBag selectInstancesOf(Class clazz);
@Override
MutableBag collect(Function super T, ? extends V> function);
@Override
MutableByteBag collectByte(ByteFunction super T> byteFunction);
@Override
MutableCharBag collectChar(CharFunction super T> charFunction);
@Override
MutableIntBag collectInt(IntFunction super T> intFunction);
@Override
MutableBooleanBag collectBoolean(BooleanFunction super T> booleanFunction);
@Override
MutableDoubleBag collectDouble(DoubleFunction super T> doubleFunction);
@Override
MutableFloatBag collectFloat(FloatFunction super T> floatFunction);
@Override
MutableLongBag collectLong(LongFunction super T> longFunction);
@Override
MutableShortBag collectShort(ShortFunction super T> shortFunction);
@Override
MutableBag collectWith(Function2 super T, ? super P, ? extends V> function, P parameter);
@Override
MutableBag collectIf(Predicate super T> predicate, Function super T, ? extends V> function);
@Override
MutableBag flatCollect(Function super T, ? extends Iterable> function);
/**
* @since 8.0
*/
@Override
ImmutableBag toImmutable();
}