com.gs.collections.api.BooleanIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-collections-api Show documentation

GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.

There is a newer version: 7.0.3

Show newest version

/*
 * Copyright 2013 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;

import com.gs.collections.api.block.function.primitive.BooleanToObjectFunction;
import com.gs.collections.api.block.predicate.primitive.BooleanPredicate;
import com.gs.collections.api.block.procedure.primitive.BooleanProcedure;
import com.gs.collections.api.iterator.BooleanIterator;
import com.gs.collections.api.bag.primitive.MutableBooleanBag;
import com.gs.collections.api.list.primitive.MutableBooleanList;
import com.gs.collections.api.set.primitive.MutableBooleanSet;

/**
 * BooleanIterable is an interface which is memory-optimized for boolean primitives.
 * It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc.
 * The API also includes an external iterator method, which returns an BooleanIterator. BooleanIterator helps iterate over the BooleanIterable without boxing the primitives.
 * This file was automatically generated from template file primitiveIterable.stg.
 */
public interface BooleanIterable extends PrimitiveIterable
{
    BooleanIterator booleanIterator();

    boolean[] toArray();

    boolean contains(boolean value);

    boolean containsAll(boolean... source);

    boolean containsAll(BooleanIterable source);

    void forEach(BooleanProcedure procedure);

    BooleanIterable select(BooleanPredicate predicate);

    BooleanIterable reject(BooleanPredicate predicate);

     RichIterable collect(BooleanToObjectFunction function);

    boolean detectIfNone(BooleanPredicate predicate, boolean ifNone);

    int count(BooleanPredicate predicate);

    boolean anySatisfy(BooleanPredicate predicate);

    boolean allSatisfy(BooleanPredicate predicate);

    boolean noneSatisfy(BooleanPredicate predicate);

    MutableBooleanList toList();

    MutableBooleanSet toSet();

    MutableBooleanBag toBag();

    LazyBooleanIterable asLazy();

}