com.gs.collections.api.set.UnsortedSetIterable 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.set;

import java.util.concurrent.ExecutorService;

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.multimap.set.UnsortedSetMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.set.primitive.BooleanSet;
import com.gs.collections.api.set.primitive.ByteSet;
import com.gs.collections.api.set.primitive.CharSet;
import com.gs.collections.api.set.primitive.DoubleSet;
import com.gs.collections.api.set.primitive.FloatSet;
import com.gs.collections.api.set.primitive.IntSet;
import com.gs.collections.api.set.primitive.LongSet;
import com.gs.collections.api.set.primitive.ShortSet;
import com.gs.collections.api.tuple.Pair;

/**
 * An iterable whose items are unique.
 */
public interface UnsortedSetIterable
        extends SetIterable
{
    /**
     * Returns the set whose members are all possible subsets of {@code this}. For example, the powerset of [1, 2] is
     * [[], [1], [2], [1, 2]].
     */
    UnsortedSetIterable> powerSet();

     UnsortedSetIterable collect(Function function);

    BooleanSet collectBoolean(BooleanFunction booleanFunction);

    ByteSet collectByte(ByteFunction byteFunction);

    CharSet collectChar(CharFunction charFunction);

    DoubleSet collectDouble(DoubleFunction doubleFunction);

    FloatSet collectFloat(FloatFunction floatFunction);

    IntSet collectInt(IntFunction intFunction);

    LongSet collectLong(LongFunction longFunction);

    ShortSet collectShort(ShortFunction shortFunction);

     UnsortedSetIterable collectWith(Function2 function, P parameter);

     UnsortedSetIterable collectIf(Predicate predicate, Function function);

     UnsortedSetIterable flatCollect(Function> function);

     UnsortedSetMultimap groupBy(Function function);

     UnsortedSetMultimap groupByEach(Function> function);

    UnsortedSetIterable union(SetIterable set);

    UnsortedSetIterable intersect(SetIterable set);

    UnsortedSetIterable difference(SetIterable subtrahendSet);

    UnsortedSetIterable symmetricDifference(SetIterable setB);

    UnsortedSetIterable select(Predicate predicate);

     UnsortedSetIterable selectWith(Predicate2 predicate, P parameter);

    UnsortedSetIterable reject(Predicate predicate);

     UnsortedSetIterable rejectWith(Predicate2 predicate, P parameter);

     UnsortedSetIterable selectInstancesOf(Class clazz);

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

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

    /**
     * Converts the UnsortedSetIterable to an immutable implementation. Returns this for immutable sets.
     *
     * @since 5.0
     */
    ImmutableSet toImmutable();

    ParallelUnsortedSetIterable asParallel(ExecutorService executorService, int batchSize);
}