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

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.ImmutableBooleanBag;
import org.eclipse.collections.api.bag.primitive.ImmutableByteBag;
import org.eclipse.collections.api.bag.primitive.ImmutableCharBag;
import org.eclipse.collections.api.bag.primitive.ImmutableDoubleBag;
import org.eclipse.collections.api.bag.primitive.ImmutableFloatBag;
import org.eclipse.collections.api.bag.primitive.ImmutableIntBag;
import org.eclipse.collections.api.bag.primitive.ImmutableLongBag;
import org.eclipse.collections.api.bag.primitive.ImmutableShortBag;
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.list.ImmutableList;
import org.eclipse.collections.api.multimap.bag.ImmutableBagMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionImmutableBag;
import org.eclipse.collections.api.set.ImmutableSet;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.tuple.Pair;
import org.eclipse.collections.api.tuple.primitive.ObjectIntPair;

/**
 * @since 1.0
 */
public interface ImmutableBag extends UnsortedBag, ImmutableBagIterable
{
    @Override
    ImmutableBag newWith(T element);

    @Override
    ImmutableBag newWithout(T element);

    @Override
    ImmutableBag newWithAll(Iterable elements);

    @Override
    ImmutableBag newWithoutAll(Iterable elements);

    @Override
    ImmutableBag selectByOccurrences(IntPredicate predicate);

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

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

    @Override
    ImmutableBag tap(Procedure procedure);

    @Override
    ImmutableBag select(Predicate predicate);

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

    @Override
    ImmutableBag reject(Predicate predicate);

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

    @Override
    PartitionImmutableBag partition(Predicate predicate);

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

    @Override
     ImmutableBag selectInstancesOf(Class clazz);

    @Override
     ImmutableBag collect(Function function);

    @Override
    ImmutableBooleanBag collectBoolean(BooleanFunction booleanFunction);

    @Override
    ImmutableByteBag collectByte(ByteFunction byteFunction);

    @Override
    ImmutableCharBag collectChar(CharFunction charFunction);

    @Override
    ImmutableDoubleBag collectDouble(DoubleFunction doubleFunction);

    @Override
    ImmutableFloatBag collectFloat(FloatFunction floatFunction);

    @Override
    ImmutableIntBag collectInt(IntFunction intFunction);

    @Override
    ImmutableLongBag collectLong(LongFunction longFunction);

    @Override
    ImmutableShortBag collectShort(ShortFunction shortFunction);

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

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

    @Override
     ImmutableBag collectWithOccurrences(ObjectIntToObjectFunction function);

    @Override
     ImmutableBag flatCollect(Function> function);

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

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

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

    /**
     * @since 10.0.0
     */
    @Override
    default  ImmutableBag countByEach(Function> function)
    {
        return this.flatCollect(function);
    }

    @Override
     ImmutableBagMultimap groupBy(Function function);

    @Override
     ImmutableBagMultimap groupByEach(Function> function);

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

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

    /**
     * @since 6.0
     */
    @Override
    ImmutableList> topOccurrences(int count);

    /**
     * @since 6.0
     */
    @Override
    ImmutableList> bottomOccurrences(int count);
}