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
23 /**
24 * Like {@link Runnable} but throws {@link IOException}.
25 *
26 * @since 2.12.0
27 */
28 @FunctionalInterface
29 public interface IORunnable {
30
31 /**
32 * Returns the constant no-op runnable.
33 *
34 * @return a constant no-op runnable.
35 * @since 2.16.0
36 */
37 static IORunnable noop() {
38 return Constants.IO_RUNNABLE;
39 }
40
41 /**
42 * Creates a {@link Runnable} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
43 *
44 * @return an UncheckedIOException Predicate.
45 */
46 default Runnable asRunnable() {
47 return () -> Uncheck.run(this);
48 }
49
50 /**
51 * Like {@link Runnable#run()} but throws {@link IOException}.
52 *
53 * @throws IOException if an I/O error occurs.
54 */
55 void run() throws IOException;
56 }