001/*
002 * MIT License
003 *
004 * Copyright (c) 2023 Michael Cowan
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in all
014 * copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022 * SOFTWARE.
023 */
024
025package io.blt.util.functional;
026
027/**
028 * Represents a supplier of results that may throw.
029 *
030 * @param <T> the type of results supplied by this supplier
031 * @param <E> the type of {@code Throwable} that may be thrown by this supplier
032 */
033@FunctionalInterface
034public interface ThrowingSupplier<T, E extends Throwable> {
035
036    /**
037     * Returns a result.
038     *
039     * @return a result
040     * @throws E {@code Throwable} that may be thrown
041     */
042    T get() throws E;
043
044    /**
045     * Returns the result of {@link ThrowingSupplier#get()} if no exception is thrown, else returns {@code value}.
046     *
047     * @param value returned if an exception is thrown when calling {@link ThrowingSupplier#get()}
048     * @return result of {@link ThrowingSupplier#get()} if no exception is thrown, else {@code value}
049     */
050    default T orOnException(T value) {
051        try {
052            return get();
053        } catch (Throwable e) {
054            return value;
055        }
056    }
057}