org.eclipse.collections.api.partition.bag.PartitionMutableBagIterable 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) 2021 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.partition.bag;

import org.eclipse.collections.api.bag.MutableBagIterable;
import org.eclipse.collections.api.partition.PartitionMutableCollection;

/**
 * A PartitionMutableBagIterable is the result of splitting a mutable bag into two MutableBagIterables based on a Predicate.
 * The results that answer true for the Predicate will be returned from the getSelected() method and the results that answer
 * false for the predicate will be returned from the getRejected() method.
 */
public interface PartitionMutableBagIterable extends PartitionMutableCollection, PartitionBag
{
    @Override
    MutableBagIterable getSelected();

    @Override
    MutableBagIterable getRejected();

    @Override
    PartitionImmutableBagIterable toImmutable();
}