    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.lang3.function;
    019
    020import java.util.function.BooleanSupplier;
    021
    022/**
    023 * A functional interface like {@link BooleanSupplier} that declares a {@code Throwable}.
    024 *
    025 * @param <E> Thrown exception.
    026 * @since 3.11
    027 */
    028@FunctionalInterface
    029public interface FailableBooleanSupplier<E extends Throwable> {
    030
    031    /**
    032     * Supplies a boolean.
    033     *
    034     * @return a result
    035     * @throws E if the supplier fails
    036     */
    037    boolean getAsBoolean() throws E;
    038}