1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.io.function;
19
20 import java.io.IOException;
21 import java.util.Objects;
22
23 /**
24 * Like {@link Iterable} but throws {@link IOException}.
25 *
26 * @param <T> the type of elements returned by the iterable.
27 * @since 2.19.0
28 */
29 public interface IOIterable<T> {
30
31 /**
32 * Like {@link Iterable#iterator()}.
33 *
34 * @param action The action to be performed for each element.
35 * @throws NullPointerException if the specified action is null.
36 * @throws IOException thrown by the given action.
37 * @see Iterable#iterator()
38 */
39 default void forEach(final IOConsumer<? super T> action) throws IOException {
40 iterator().forEachRemaining(Objects.requireNonNull(action));
41 }
42
43 /**
44 * Like {@link Iterable#iterator()}.
45 *
46 * @return See {@link Iterable#iterator() delegate}.
47 * @see Iterable#iterator()
48 */
49 IOIterator<T> iterator();
50
51 /**
52 * Like {@link Iterable#spliterator()}.
53 *
54 * @return See {@link Iterable#spliterator() delegate}.
55 * @see Iterable#spliterator()
56 */
57 default IOSpliterator<T> spliterator() {
58 return IOSpliteratorAdapter.adapt(new UncheckedIOIterable<>(this).spliterator());
59 }
60
61 /**
62 * Unwraps this instance and returns the underlying {@link Iterable}.
63 * <p>
64 * Implementations may not have anything to unwrap and that behavior is undefined for now.
65 * </p>
66 * @return the underlying Iterable.
67 */
68 Iterable<T> unwrap();
69
70 }