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.io.UncheckedIOException;
22 import java.util.function.Supplier;
23
24 /**
25 * Like {@link Supplier} but throws {@link IOException}.
26 * <p>
27 * Using an IOSupplier allows you to compose usage of checked and unchecked exceptions as you best see fit.
28 * </p>
29 *
30 * @param <T> the return type of the operations.
31 * @since 2.7
32 */
33 @FunctionalInterface
34 public interface IOSupplier<T> {
35
36 /**
37 * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
38 *
39 * @return an UncheckedIOException Supplier.
40 * @since 2.12.0
41 */
42 default Supplier<T> asSupplier() {
43 return this::getUnchecked;
44 }
45
46 /**
47 * Gets a result.
48 *
49 * @return a result.
50 * @throws IOException if an I/O error occurs.
51 * @see #getUnchecked()
52 */
53 T get() throws IOException;
54
55 /**
56 * Gets a result.
57 *
58 * @return a result.
59 * @throws UncheckedIOException if an I/O error occurs.
60 * @see #get()
61 * @since 2.17.0
62 */
63 default T getUnchecked() throws UncheckedIOException {
64 return Uncheck.get(this);
65 }
66 }