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 *
27 * @param <T> the return type of the operations.
28 * @since 2.7
29 */
30 @FunctionalInterface
31 public interface IOSupplier<T> {
32
33 /**
34 * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
35 *
36 * @return an UncheckedIOException Supplier.
37 * @since 2.12.0
38 */
39 default Supplier<T> asSupplier() {
40 return () -> Uncheck.get(this);
41 }
42
43 /**
44 * Gets a result.
45 *
46 * @return a result
47 * @throws IOException if an I/O error occurs.
48 */
49 T get() throws IOException;
50 }