IOLongSupplier.java

  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. package org.apache.commons.io.function;

  18. import java.io.IOException;
  19. import java.io.UncheckedIOException;
  20. import java.util.function.LongSupplier;
  21. import java.util.function.Supplier;

  22. /**
  23.  * Like {@link LongSupplier} but throws {@link IOException}.
  24.  *
  25.  * @since 2.14.0
  26.  */
  27. @FunctionalInterface
  28. public interface IOLongSupplier {

  29.     /**
  30.      * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
  31.      *
  32.      * @return an UncheckedIOException Supplier.
  33.      */
  34.     default LongSupplier asSupplier() {
  35.         return () -> Uncheck.getAsLong(this);
  36.     }

  37.     /**
  38.      * Gets a result.
  39.      *
  40.      * @return a result
  41.      * @throws IOException if an I/O error occurs.
  42.      */
  43.     long getAsLong() throws IOException;
  44. }