com.gs.collections.api.collection.ImmutableCollection Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 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.collection;

import com.gs.collections.api.RichIterable;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function0;
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.block.procedure.Procedure2;
import com.gs.collections.api.collection.primitive.ImmutableBooleanCollection;
import com.gs.collections.api.collection.primitive.ImmutableByteCollection;
import com.gs.collections.api.collection.primitive.ImmutableCharCollection;
import com.gs.collections.api.collection.primitive.ImmutableDoubleCollection;
import com.gs.collections.api.collection.primitive.ImmutableFloatCollection;
import com.gs.collections.api.collection.primitive.ImmutableIntCollection;
import com.gs.collections.api.collection.primitive.ImmutableLongCollection;
import com.gs.collections.api.collection.primitive.ImmutableShortCollection;
import com.gs.collections.api.map.ImmutableMap;
import com.gs.collections.api.multimap.ImmutableMultimap;
import com.gs.collections.api.partition.PartitionImmutableCollection;
import com.gs.collections.api.tuple.Pair;
import net.jcip.annotations.Immutable;

/**
 * ImmutableCollection is the common interface between ImmutableList and ImmutableSet.
 */
@Immutable
public interface ImmutableCollection
        extends RichIterable
{
    ImmutableCollection newWith(T element);

    ImmutableCollection newWithout(T element);

    ImmutableCollection newWithAll(Iterable elements);

    ImmutableCollection newWithoutAll(Iterable elements);

    ImmutableCollection tap(Procedure procedure);

    ImmutableCollection select(Predicate predicate);

     ImmutableCollection selectWith(Predicate2 predicate, P parameter);

    ImmutableCollection reject(Predicate predicate);

    
 ImmutableCollection rejectWith(Predicate2 predicate, P parameter);

    PartitionImmutableCollection partition(Predicate predicate);

     PartitionImmutableCollection partitionWith(Predicate2 predicate, P parameter);

     ImmutableCollection selectInstancesOf(Class clazz);

     ImmutableCollection collect(Function function);

    ImmutableBooleanCollection collectBoolean(BooleanFunction booleanFunction);

    ImmutableByteCollection collectByte(ByteFunction byteFunction);

    ImmutableCharCollection collectChar(CharFunction charFunction);

    ImmutableDoubleCollection collectDouble(DoubleFunction doubleFunction);

    ImmutableFloatCollection collectFloat(FloatFunction floatFunction);

    ImmutableIntCollection collectInt(IntFunction intFunction);

    ImmutableLongCollection collectLong(LongFunction longFunction);

    ImmutableShortCollection collectShort(ShortFunction shortFunction);

     ImmutableCollection collectWith(Function2 function, P parameter);

     ImmutableCollection collectIf(Predicate predicate, Function function);

     ImmutableCollection flatCollect(Function> function);

     ImmutableMultimap groupBy(Function function);

     ImmutableMultimap groupByEach(Function> function);

     ImmutableMap groupByUniqueKey(Function function);

     ImmutableCollection> zip(Iterable that);

    ImmutableCollection> zipWithIndex();

     ImmutableMap aggregateInPlaceBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Procedure2 mutatingAggregator);

     ImmutableMap aggregateBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Function2 nonMutatingAggregator);
}