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  import java.util.function.IntToLongFunction;
21  
22  /**
23   * A functional interface like {@link IntToLongFunction} that declares a {@link Throwable}.
24   *
25   * @param <E> The kind of thrown exception or error.
26   * @since 3.11
27   */
28  @FunctionalInterface
29  public interface FailableIntToLongFunction<E extends Throwable> {
30  
31      /** NOP singleton */
32      @SuppressWarnings("rawtypes")
33      FailableIntToLongFunction NOP = t -> 0L;
34  
35      /**
36       * Returns The NOP singleton.
37       *
38       * @param <E> The kind of thrown exception or error.
39       * @return The NOP singleton.
40       */
41      @SuppressWarnings("unchecked")
42      static <E extends Throwable> FailableIntToLongFunction<E> nop() {
43          return NOP;
44      }
45  
46      /**
47       * Applies this function to the given argument.
48       *
49       * @param value the function argument
50       * @return the function result
51       * @throws E Thrown when the function fails.
52       */
53      long applyAsLong(int value) throws E;
54  }