org.eclipse.collections.api.set.MutableSetIterable Maven / Gradle / Ivy

Go to download
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) 2016 Goldman Sachs.
 * 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.set;

import java.util.Set;

import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.multimap.set.MutableSetIterableMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.set.PartitionMutableSetIterable;
import org.eclipse.collections.api.tuple.Pair;

/**
 * @since 6.0
 */
public interface MutableSetIterable extends SetIterable, MutableCollection, Set
{
    @Override
    MutableSetIterable tap(Procedure procedure);

    @Override
    MutableSetIterable select(Predicate predicate);

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

    @Override
    MutableSetIterable reject(Predicate predicate);

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

    @Override
    PartitionMutableSetIterable partition(Predicate predicate);

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

    @Override
     MutableSetIterable selectInstancesOf(Class clazz);

    @Override
     MutableSetIterableMultimap groupBy(Function function);

    @Override
     MutableSetIterableMultimap groupByEach(Function> function);

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

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

    @Override
    default MutableSetIterable with(T element)
    {
        this.add(element);
        return this;
    }

    @Override
    default MutableSetIterable without(T element)
    {
        this.remove(element);
        return this;
    }

    @Override
    default MutableSetIterable withAll(Iterable elements)
    {
        this.addAllIterable(elements);
        return this;
    }

    @Override
    default MutableSetIterable withoutAll(Iterable elements)
    {
        this.removeAllIterable(elements);
        return this;
    }
}