001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.io.function;
019
020import java.io.IOException;
021import java.io.UncheckedIOException;
022
023/**
024 * Like {@link Runnable} but throws {@link IOException}.
025 *
026 * @since 2.12.0
027 */
028@FunctionalInterface
029public interface IORunnable {
030
031    /**
032     * Returns the constant no-op runnable.
033     *
034     * @return a constant no-op runnable.
035     * @since 2.16.0
036     */
037    static IORunnable noop() {
038        return Constants.IO_RUNNABLE;
039    }
040
041    /**
042     * Creates a {@link Runnable} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
043     *
044     * @return an UncheckedIOException Predicate.
045     */
046    default Runnable asRunnable() {
047        return () -> Uncheck.run(this);
048    }
049
050    /**
051     * Like {@link Runnable#run()} but throws {@link IOException}.
052     *
053     * @throws IOException if an I/O error occurs.
054     */
055    void run() throws IOException;
056}