org.eclipse.collections.api.bag.MutableBag Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections-api Show documentation
There is a newer version: 12.0.0.M3
Show newest version
/*
 * Copyright (c) 2018 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.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.ObjectIntToObjectFunction;
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.factory.Sets;
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);

    /**
     * @since 9.2
     */
    @Override
    default MutableBag selectDuplicates()
    {
        return this.selectByOccurrences(occurrences -> occurrences > 1);
    }

    /**
     * @since 9.2
     */
    @Override
    default MutableSet selectUnique()
    {
        MutableSet result = Sets.mutable.empty();
        this.forEachWithOccurrences((each, occurrences) ->
        {
            if (occurrences == 1)
            {
                result.add(each);
            }
        });
        return result;
    }

    @Override
    default MutableBag with(T element)
    {
        this.add(element);
        return this;
    }

    @Override
    default MutableBag without(T element)
    {
        this.remove(element);
        return this;
    }

    @Override
    default MutableBag withAll(Iterable elements)
    {
        this.addAllIterable(elements);
        return this;
    }

    @Override
    default MutableBag withoutAll(Iterable elements)
    {
        this.removeAllIterable(elements);
        return this;
    }

    @Override
    MutableBag newEmpty();

    @Override
    MutableBag asUnmodifiable();

    @Override
    MutableBag asSynchronized();

    @Override
    PartitionMutableBag partition(Predicate predicate);

    @Override
     PartitionMutableBag partitionWith(Predicate2 predicate, P parameter);

    @Override
     MutableBagMultimap groupBy(Function function);

    @Override
     MutableBagMultimap groupByEach(Function> function);

    /**
     * @since 9.0
     */
    @Override
    default  MutableBag countBy(Function function)
    {
        return this.collect(function);
    }

    /**
     * @since 9.0
     */
    @Override
    default  MutableBag countByWith(Function2 function, P parameter)
    {
        return this.collectWith(function, parameter);
    }

    /**
     * @since 10.0.0
     */
    @Override
    default  MutableBag countByEach(Function> function)
    {
        return this.flatCollect(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 procedure);

    @Override
    MutableBag select(Predicate predicate);

    @Override
    
 MutableBag selectWith(Predicate2 predicate, P parameter);

    @Override
    MutableBag reject(Predicate predicate);

    @Override
     MutableBag rejectWith(Predicate2 predicate, P parameter);

    @Override
     MutableBag selectInstancesOf(Class clazz);

    @Override
     MutableBag collect(Function function);

    @Override
    MutableByteBag collectByte(ByteFunction byteFunction);

    @Override
    MutableCharBag collectChar(CharFunction charFunction);

    @Override
    MutableIntBag collectInt(IntFunction intFunction);

    @Override
    MutableBooleanBag collectBoolean(BooleanFunction booleanFunction);

    @Override
    MutableDoubleBag collectDouble(DoubleFunction doubleFunction);

    @Override
    MutableFloatBag collectFloat(FloatFunction floatFunction);

    @Override
    MutableLongBag collectLong(LongFunction longFunction);

    @Override
    MutableShortBag collectShort(ShortFunction shortFunction);

    @Override
     MutableBag collectWith(Function2 function, P parameter);

    @Override
     MutableBag collectIf(Predicate predicate, Function function);

    @Override
     MutableBag collectWithOccurrences(ObjectIntToObjectFunction function);

    @Override
     MutableBag flatCollect(Function> function);

    /**
     * @since 9.2
     */
    @Override
    default  MutableBag flatCollectWith(Function2> function, P parameter)
    {
        return this.flatCollect(each -> function.apply(each, parameter));
    }

    /**
     * @since 8.0
     */
    @Override
    ImmutableBag toImmutable();
}