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

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.set.ImmutableSetMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.set.PartitionImmutableSet;
import com.gs.collections.api.set.primitive.ImmutableBooleanSet;
import com.gs.collections.api.set.primitive.ImmutableByteSet;
import com.gs.collections.api.set.primitive.ImmutableCharSet;
import com.gs.collections.api.set.primitive.ImmutableDoubleSet;
import com.gs.collections.api.set.primitive.ImmutableFloatSet;
import com.gs.collections.api.set.primitive.ImmutableIntSet;
import com.gs.collections.api.set.primitive.ImmutableLongSet;
import com.gs.collections.api.set.primitive.ImmutableShortSet;
import com.gs.collections.api.tuple.Pair;
import net.jcip.annotations.Immutable;

/**
 * ImmutableSet is the non-modifiable equivalent interface to {@link MutableSet}. {@link MutableSet#toImmutable()} will
 * give you an appropriately trimmed implementation of ImmutableSet.  All ImmutableSet implementations must implement
 * the java.util.Set interface so they can satisfy the equals() contract and be compared against other set structures
 * like UnifiedSet or HashSet.
 */
@Immutable
public interface ImmutableSet
        extends UnsortedSetIterable, ImmutableSetIterable
{
    ImmutableSet newWith(T element);

    ImmutableSet newWithout(T element);

    ImmutableSet newWithAll(Iterable elements);

    ImmutableSet newWithoutAll(Iterable elements);

    ImmutableSet tap(Procedure procedure);

    ImmutableSet select(Predicate predicate);

     ImmutableSet selectWith(Predicate2 predicate, P parameter);

    ImmutableSet reject(Predicate predicate);

    
 ImmutableSet rejectWith(Predicate2 predicate, P parameter);

    PartitionImmutableSet partition(Predicate predicate);

     PartitionImmutableSet partitionWith(Predicate2 predicate, P parameter);

     ImmutableSet selectInstancesOf(Class clazz);

     ImmutableSet collect(Function function);

    ImmutableBooleanSet collectBoolean(BooleanFunction booleanFunction);

    ImmutableByteSet collectByte(ByteFunction byteFunction);

    ImmutableCharSet collectChar(CharFunction charFunction);

    ImmutableDoubleSet collectDouble(DoubleFunction doubleFunction);

    ImmutableFloatSet collectFloat(FloatFunction floatFunction);

    ImmutableIntSet collectInt(IntFunction intFunction);

    ImmutableLongSet collectLong(LongFunction longFunction);

    ImmutableShortSet collectShort(ShortFunction shortFunction);

     ImmutableSet collectWith(Function2 function, P parameter);

     ImmutableSet collectIf(Predicate predicate, Function function);

     ImmutableSet flatCollect(Function> function);

     ImmutableSetMultimap groupBy(Function function);

     ImmutableSetMultimap groupByEach(Function> function);

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

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

    Set castToSet();

    ImmutableSet union(SetIterable set);

    ImmutableSet intersect(SetIterable set);

    ImmutableSet difference(SetIterable subtrahendSet);

    ImmutableSet symmetricDifference(SetIterable setB);

    ImmutableSet> powerSet();
}