/*
 * Copyright (c) 2020 Goldman Sachs and others.
 * 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.map.primitive;

import org.eclipse.collections.api.BooleanIterable;
import org.eclipse.collections.api.bag.Bag;
import org.eclipse.collections.api.bag.primitive.BooleanBag;
import org.eclipse.collections.api.block.function.primitive.BooleanToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.BooleanPredicate;
import org.eclipse.collections.api.block.procedure.primitive.BooleanProcedure;
import org.eclipse.collections.api.collection.primitive.MutableBooleanCollection;

This file was automatically generated from template file primitiveValuesMap.stg.
Since:
6.0./**
 * This file was automatically generated from template file primitiveValuesMap.stg.
 *
 * @since 6.0.
 */
public interface BooleanValuesMap extends BooleanIterable
{
    
Returns whether or not this map contains the value.
Params:
value – the value to test
Returns:
if this collection contains the value/**
     * Returns whether or not this map contains the value.
     * @param value the value to test
     * @return if this collection contains the value
     */
    boolean containsValue(boolean value);

    
Iterates through each value in this map.
Params:
procedure – the procedure to invoke for each value in this map./**
     * Iterates through each value in this map.
     * @param procedure the procedure to invoke for each value in this map.
     */
    void forEachValue(BooleanProcedure procedure);

    
Returns the values in this map as a separate collection. The returned collection is backed by the map, so any
changes made to the returned collection will affect the state of this map.
Returns:
the values as a collection backed by this map/**
     * Returns the values in this map as a separate collection. The returned collection is backed by the map, so any
     * changes made to the returned collection will affect the state of this map.
     * @return the values as a collection backed by this map
     */
    MutableBooleanCollection values();

    @Override
    BooleanBag select(BooleanPredicate predicate);

    @Override
    BooleanBag reject(BooleanPredicate predicate);

    
Since:
9.0./**
     * @since 9.0.
     */
    @Override
    default BooleanValuesMap tap(BooleanProcedure procedure)
    {
        this.forEach(procedure);
        return this;
    }

    @Override
    <V> Bag<V> collect(BooleanToObjectFunction<? extends V> function);
}