com.gs.collections.api.bag.MutableBag Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.bag;

import com.gs.collections.api.bag.primitive.MutableBooleanBag;
import com.gs.collections.api.bag.primitive.MutableByteBag;
import com.gs.collections.api.bag.primitive.MutableCharBag;
import com.gs.collections.api.bag.primitive.MutableDoubleBag;
import com.gs.collections.api.bag.primitive.MutableFloatBag;
import com.gs.collections.api.bag.primitive.MutableIntBag;
import com.gs.collections.api.bag.primitive.MutableLongBag;
import com.gs.collections.api.bag.primitive.MutableShortBag;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.function.primitive.BooleanFunction;
import com.gs.collections.api.block.function.primitive.ByteFunction;
import com.gs.collections.api.block.function.primitive.CharFunction;
import com.gs.collections.api.block.function.primitive.DoubleFunction;
import com.gs.collections.api.block.function.primitive.FloatFunction;
import com.gs.collections.api.block.function.primitive.IntFunction;
import com.gs.collections.api.block.function.primitive.LongFunction;
import com.gs.collections.api.block.function.primitive.ShortFunction;
import com.gs.collections.api.block.predicate.Predicate;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.block.predicate.primitive.IntPredicate;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.map.MutableMap;
import com.gs.collections.api.multimap.bag.MutableBagMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.bag.PartitionMutableBag;
import com.gs.collections.api.set.MutableSet;
import com.gs.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
{
    MutableMap toMapOfItemToCount();

    MutableBag selectByOccurrences(IntPredicate predicate);

    MutableBag with(T element);

    MutableBag without(T element);

    MutableBag withAll(Iterable elements);

    MutableBag withoutAll(Iterable elements);

    MutableBag newEmpty();

    MutableBag asUnmodifiable();

    MutableBag asSynchronized();

    PartitionMutableBag partition(Predicate predicate);

     PartitionMutableBag partitionWith(Predicate2 predicate, P parameter);

     MutableBagMultimap groupBy(Function function);

     MutableBagMultimap groupByEach(Function> function);

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
     */
    @Deprecated
     MutableBag> zip(Iterable that);

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
     */
    @Deprecated
    MutableSet> zipWithIndex();

    MutableBag tap(Procedure procedure);

    MutableBag select(Predicate predicate);

    
 MutableBag selectWith(Predicate2 predicate, P parameter);

    MutableBag reject(Predicate predicate);

     MutableBag rejectWith(Predicate2 predicate, P parameter);

     MutableBag selectInstancesOf(Class clazz);

     MutableBag collect(Function function);

    MutableByteBag collectByte(ByteFunction byteFunction);

    MutableCharBag collectChar(CharFunction charFunction);

    MutableIntBag collectInt(IntFunction intFunction);

    MutableBooleanBag collectBoolean(BooleanFunction booleanFunction);

    MutableDoubleBag collectDouble(DoubleFunction doubleFunction);

    MutableFloatBag collectFloat(FloatFunction floatFunction);

    MutableLongBag collectLong(LongFunction longFunction);

    MutableShortBag collectShort(ShortFunction shortFunction);

     MutableBag collectWith(Function2 function, P parameter);

     MutableBag collectIf(Predicate predicate, Function function);

     MutableBag flatCollect(Function> function);
}