org.eclipse.collections.api.bag.ImmutableBagIterable 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) 2020 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.block.function.Function;
import org.eclipse.collections.api.block.function.primitive.ObjectIntToObjectFunction;
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.collection.ImmutableCollection;
import org.eclipse.collections.api.map.MutableMapIterable;
import org.eclipse.collections.api.multimap.bag.ImmutableBagIterableMultimap;
import org.eclipse.collections.api.partition.bag.PartitionImmutableBagIterable;
import org.eclipse.collections.api.set.ImmutableSetIterable;
import org.eclipse.collections.api.tuple.Pair;

public interface ImmutableBagIterable extends Bag, ImmutableCollection
{
    @Override
    ImmutableBagIterable tap(Procedure procedure);

    @Override
    ImmutableBagIterable select(Predicate predicate);

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

    @Override
    ImmutableBagIterable reject(Predicate predicate);

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

    @Override
    PartitionImmutableBagIterable partition(Predicate predicate);

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

    @Override
     ImmutableBagIterable selectInstancesOf(Class clazz);

    @Override
     ImmutableBagIterableMultimap groupBy(Function function);

    @Override
     ImmutableBagIterableMultimap groupByEach(Function> function);

    @Override
    ImmutableSetIterable> zipWithIndex();

    @Override
    ImmutableBagIterable selectByOccurrences(IntPredicate predicate);

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

    /**
     * @since 9.2
     */
    @Override
    ImmutableSetIterable selectUnique();

    @Override
    MutableMapIterable toMapOfItemToCount();

    @Override
     ImmutableCollection collectWithOccurrences(ObjectIntToObjectFunction function);
}