com.diozero.api.function.VoidConsumer Maven / Gradle / Ivy
package com.diozero.api.function;
/*-
* #%L
* Organisation: diozero
* Project: diozero - Core
* Filename: VoidConsumer.java
*
* This file is part of the diozero project. More information about this project
* can be found at https://www.diozero.com/.
* %%
* Copyright (C) 2016 - 2024 diozero
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import java.util.Objects;
import java.util.function.Consumer;
/**
* Represents an operation that accepts a no-valued argument and returns no
* result. This is a specialization of {@link Consumer} for no parameters.
* Unlike most other functional interfaces, {@code VoidConsumer} is expected to
* operate via side-effects.
*
*
* This is a functional interface whose
* functional method is {@link #accept()}.
*
* @see Consumer
*/
@FunctionalInterface
public interface VoidConsumer {
/**
* Performs this operation on the given argument.
*/
void accept();
/**
* Returns a composed {@code VoidConsumer} that performs, in sequence, this
* operation followed by the {@code after} operation. If performing either
* operation throws an exception, it is relayed to the caller of the composed
* operation. If performing this operation throws an exception, the
* {@code after} operation will not be performed.
*
* @param after the operation to perform after this operation
* @return a composed {@code VoidConsumer} that performs in sequence this
* operation followed by the {@code after} operation
* @throws NullPointerException if {@code after} is null
*/
default VoidConsumer andThen(VoidConsumer after) {
Objects.requireNonNull(after);
return () -> {
accept();
after.accept();
};
}
}