View Javadoc
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.lang3.function;
19  
20  /**
21   * A functional interface like {@link Runnable} that declares a kind of {@link Throwable}.
22   *
23   * @param <E> The kind of {@link Throwable}.
24   * @since 3.11
25   */
26  @FunctionalInterface
27  public interface FailableRunnable<E extends Throwable> {
28  
29      /**
30       * Runs the function.
31       *
32       * @throws E Thrown when the function fails.
33       */
34      void run() throws E;
35  }