org.eu.zajc.ef.supplier.except.EBooleanSupplier Maven / Gradle / Ivy
Show all versions of extended-functions Show documentation
// SPDX-License-Identifier: Apache-2.0
/*
* extended-functions
* Copyright 2021-2024 Marko Zajc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eu.zajc.ef.supplier.except;
import static org.eu.zajc.ef.Utilities.asUnchecked;
import java.util.function.*;
/**
* Represents a supplier of {@code boolean}-valued results. This is the
* {@code boolean}-producing primitive specialization of {@link ESupplier}.
*
*
* Additionally, the functional method is allowed to throw a generic
* {@link Throwable} of type {@code E}.
*
*
* There is no requirement that a new or distinct result be returned each time the
* supplier is invoked.
*
*
* This is a functional interface whose functional method is
* {@link #getCheckedAsBoolean()}.
*
* @param
* {@link Throwable} type
*
* @see Supplier
*
* @author Marko Zajc
*/
@FunctionalInterface
public interface EBooleanSupplier extends BooleanSupplier {
@Override
default boolean getAsBoolean() {
try {
return getCheckedAsBoolean();
} catch (Throwable e) { // NOSONAR can't catch generic exceptions
throw asUnchecked(e);
}
}
/**
* Same as {@link #getAsBoolean()}, but throws a checked exception.
*
* @return a result
*
* @throws E
* the defined exception type
*/
boolean getCheckedAsBoolean() throws E;
/**
* Same as {@link #getAsBoolean()}, but throws a checked exception.
*
* @return a result
*
* @throws E
* the defined exception type
*
* @deprecated Since 1.5, for removal. Use {@link #getCheckedAsBoolean()} instead
*/
@Deprecated
default boolean getChecked() throws E {
return getCheckedAsBoolean();
}
}