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 * https://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.io.UncheckedIOException;
22 import java.util.Objects;
23
24 /**
25 * Like {@link Iterable} but throws {@link IOException}.
26 *
27 * @param <T> the type of elements returned by the iterable.
28 * @since 2.19.0
29 */
30 public interface IOIterable<T> {
31
32 /**
33 * Creates an {@link Iterable} for this instance that throws {@link UncheckedIOException} instead of
34 * {@link IOException}.
35 *
36 * @return an {@link UncheckedIOException} {@link Iterable}.
37 * @since 2.21.0
38 */
39 default Iterable<T> asIterable() {
40 return new UncheckedIOIterable<>(this);
41 }
42
43 /**
44 * Like {@link Iterable#iterator()}.
45 *
46 * @param action The action to be performed for each element.
47 * @throws NullPointerException if the specified action is null.
48 * @throws IOException thrown by the given action.
49 * @see Iterable#iterator()
50 */
51 default void forEach(final IOConsumer<? super T> action) throws IOException {
52 iterator().forEachRemaining(Objects.requireNonNull(action));
53 }
54
55 /**
56 * Like {@link Iterable#iterator()}.
57 *
58 * @return See {@link Iterable#iterator() delegate}.
59 * @see Iterable#iterator()
60 */
61 IOIterator<T> iterator();
62
63 /**
64 * Like {@link Iterable#spliterator()}.
65 *
66 * @return See {@link Iterable#spliterator() delegate}.
67 * @see Iterable#spliterator()
68 */
69 default IOSpliterator<T> spliterator() {
70 return IOSpliteratorAdapter.adapt(new UncheckedIOIterable<>(this).spliterator());
71 }
72
73 /**
74 * Unwraps this instance and returns the underlying {@link Iterable}.
75 * <p>
76 * Implementations may not have anything to unwrap and that behavior is undefined for now.
77 * </p>
78 * @return the underlying Iterable.
79 */
80 Iterable<T> unwrap();
81
82 }