org.neo4j.function.ThrowingBooleanSupplier Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.function;

/**
 * Represents a supplier of boolean-valued results. This is the boolean-producing primitive specialization of {@link ThrowingSupplier}.
 * There is no requirement that a new or distinct result be returned each time the supplier is invoked.
 *
 * @param  the type of exception that may be thrown from the supplier
 */
public interface ThrowingBooleanSupplier {
    /**
     * Gets a result.
     *
     * @return a result
     * @throws E an exception if the supplier fails
     */
    boolean getAsBoolean() throws E;
}