me.hltj.vertx.function.Consumer5 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-future-utils Show documentation
Convenient Utilities for Vert.x Future
There is a newer version: 1.1.2
/*
 * vertx-future-utils - Convenient Utilities for Vert.x Future
 * https://github.com/hltj/vertx-future-utils
 *
 * Copyright (C) 2020  JiaYanwei  https://hltj.me
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This code 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * Please contact me (jiaywe#at#gmail.com, replace the '#at#' with 'at')
 * if you need additional information or have any questions.
 */
package me.hltj.vertx.function;

import java.util.Objects;
import java.util.function.Consumer;

/**
 * Represents an operation that accepts 5 input arguments and returns no
 * result.  This is the 5-arity specialization of {@link Consumer}.
 * Unlike most other functional interfaces, {@code Consumer5} is expected
 * to operate via side-effects.
 *
 * This is a functional interface
 * whose functional method is {@link #accept(Object, Object, Object, Object, Object)}.
 *
 * @param  the type of the 1st argument to the operation
 * @param  the type of the 2nd argument to the operation
 * @param  the type of the 3rd argument to the operation
 * @param  the type of the 4th argument to the operation
 * @param  the type of the 5th argument to the operation
 * @see Consumer
 */
@FunctionalInterface
public interface Consumer5 {

    /**
     * Performs this operation on the given arguments.
     *
     * @param v0 the 1st input argument
     * @param v1 the 2nd input argument
     * @param v2 the 3rd input argument
     * @param v3 the 4th input argument
     * @param v4 the 5th input argument
     */
    void accept(T0 v0, T1 v1, T2 v2, T3 v3, T4 v4);

    /**
     * Returns a composed {@code Consumer5} 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 Consumer5} that performs in sequence this
     * operation followed by the {@code after} operation
     * @throws NullPointerException if {@code after} is null
     */
    default Consumer5 andThen(
            Consumer5 after
    ) {
        Objects.requireNonNull(after);

        return (v0, v1, v2, v3, v4) -> {
            accept(v0, v1, v2, v3, v4);
            after.accept(v0, v1, v2, v3, v4);
        };
    }
}