001/*
002 * Configurate
003 * Copyright (C) zml and Configurate contributors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * 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 */
017package ninja.leaping.configurate.util;
018
019import java.util.function.Supplier;
020
021/**
022 * A functional interface similar to Supplier, except allowing contained methods to throw exceptions
023 *
024 * @param <V> The value returned
025 * @param <E> The exception type thrown
026 */
027@FunctionalInterface
028public interface CheckedSupplier<V, E extends Throwable> {
029    V get() throws E;
030
031    /**
032     * Create an instance from an ordinary supplier
033     *
034     * @param consumer The supplier to convert
035     * @param <V> The type returned by the consumer
036     * @return A function that executes the provided consumer
037     */
038    static <V> CheckedSupplier<V, RuntimeException> fromSupplier(Supplier<V> consumer) {
039        return consumer::get;
040    }
041}