    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;
    022import java.util.function.LongSupplier;
    023import java.util.function.Supplier;
    024
    025/**
    026 * Like {@link LongSupplier} but throws {@link IOException}.
    027 *
    028 * @since 2.14.0
    029 */
    030@FunctionalInterface
    031public interface IOLongSupplier {
    032
    033    /**
    034     * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
    035     *
    036     * @return an UncheckedIOException Supplier.
    037     */
    038    default LongSupplier asSupplier() {
    039        return () -> Uncheck.getAsLong(this);
    040    }
    041
    042    /**
    043     * Gets a result.
    044     *
    045     * @return a result
    046     * @throws IOException if an I/O error occurs.
    047     */
    048    long getAsLong() throws IOException;
    049}