com.gs.collections.api.map.UnsortedMapIterable 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.map;

import com.gs.collections.api.bag.Bag;
import com.gs.collections.api.bag.primitive.BooleanBag;
import com.gs.collections.api.bag.primitive.ByteBag;
import com.gs.collections.api.bag.primitive.CharBag;
import com.gs.collections.api.bag.primitive.DoubleBag;
import com.gs.collections.api.bag.primitive.FloatBag;
import com.gs.collections.api.bag.primitive.IntBag;
import com.gs.collections.api.bag.primitive.LongBag;
import com.gs.collections.api.bag.primitive.ShortBag;
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.procedure.Procedure;
import com.gs.collections.api.multimap.bag.BagMultimap;
import com.gs.collections.api.multimap.set.UnsortedSetMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.bag.PartitionBag;
import com.gs.collections.api.set.UnsortedSetIterable;
import com.gs.collections.api.tuple.Pair;

/**
 * An iterable Map whose elements are unsorted.
 */
public interface UnsortedMapIterable
        extends MapIterable
{
    UnsortedSetMultimap flip();

    UnsortedMapIterable flipUniqueValues();

    UnsortedMapIterable tap(Procedure procedure);

    UnsortedMapIterable select(Predicate2 predicate);

    UnsortedMapIterable reject(Predicate2 predicate);

     UnsortedMapIterable collectValues(Function2 function);

     UnsortedMapIterable collect(Function2> function);

    Bag select(Predicate predicate);

     Bag selectWith(Predicate2 predicate, P parameter);

    Bag reject(Predicate predicate);

     Bag rejectWith(Predicate2 predicate, P parameter);

    PartitionBag partition(Predicate predicate);

     Bag selectInstancesOf(Class clazz);

     Bag collect(Function function);

    BooleanBag collectBoolean(BooleanFunction booleanFunction);

    ByteBag collectByte(ByteFunction byteFunction);

    CharBag collectChar(CharFunction charFunction);

    DoubleBag collectDouble(DoubleFunction doubleFunction);

    FloatBag collectFloat(FloatFunction floatFunction);

    IntBag collectInt(IntFunction intFunction);

    LongBag collectLong(LongFunction longFunction);

    ShortBag collectShort(ShortFunction shortFunction);

     Bag collectWith(Function2 function, P parameter);

     Bag collectIf(Predicate predicate, Function function);

     Bag flatCollect(Function> function);

     BagMultimap groupBy(Function function);

     BagMultimap groupByEach(Function> function);

     UnsortedMapIterable groupByUniqueKey(Function function);

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

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

    /**
     * Converts the UnsortedMapIterable to an immutable implementation. Returns this for immutable maps.
     *
     * @since 5.0
     */
    ImmutableMap toImmutable();
}