io.timeandspace.collect.ObjCollection Maven / Gradle / Ivy
Show all versions of smoothie-map Show documentation
/*
* Copyright (C) The SmoothieMap Authors
*
* 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 io.timeandspace.collect;
import java.util.Collection;
import java.util.function.Predicate;
public interface ObjCollection extends Collection {
/**
* Checks the given {@code predicate} on each element in this collection until all elements have
* been processed or the predicate returns false for some element, or throws an Exception.
* Exceptions thrown by the predicate are relayed to the caller.
*
* The elements will be processed in the same order as they appear in {@link #iterator()} and
* {@link #forEach}.
*
*
If the collection is empty, this method returns {@code true} immediately.
*
* @param predicate the predicate to be checked for each element
* @return {@code true} if there are no elements in the collection, or if the predicate returned
* {@code true} for all elements of the collection, {@code false} if the predicate returned
* {@code false} for some element
* @throws NullPointerException if the specified predicate is null
* @throws java.util.ConcurrentModificationException if any structural modification of the
* collection (addition or removal of an element) is detected during iteration
* @see #forEach
*/
boolean forEachWhile(Predicate predicate);
long sizeAsLong();
}