org.libj.util.function.ThrowingTriConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of util Show documentation

Supplementary utilities for classes that belong to java.util, or are considered essential as to justify existence in java.util.

There is a newer version: 0.9.1

Show newest version

/* Copyright (c) 2019 LibJ
 *
 * 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.
 *
 * You should have received a copy of The MIT License (MIT) along with this
 * program. If not, see .
 */

package org.libj.util.function;

import java.util.function.BiConsumer;

/**
 * Represents an operation that accepts two input arguments and returns no
 * result. Unlike most other functional interfaces, {@link TriConsumer} is
 * expected to operate via side-effects.
 * 
 * The {@link ThrowingBiConsumer} distinguishes itself from {@link BiConsumer} by
 * allowing the functional interface to throw an {@link Exception}. This can be
 * used to allow lambda expressions to propagate checked exceptions up the
 * expression's call stack. An example of this pattern:
 *
 * 
 * {@code
 * TriConsumer consumer = Throwing.rethrow((i, j, k) -> {
 *   if (i == 0)
 *     throw new IllegalArgumentException("i=" + i);
 * });
 * for (int i = 3; i >= 0; --i)
 *   consumer.accept(i, -i, i);
 * }
 * 
 *
 * @param  The type of the first input to the operation.
 * @param  The type of the second input to the operation.
 * @param  The type of the third input to the operation.
 * @param  The type of the exception that can be thrown.
 * @see Throwing
 */
@FunctionalInterface
public interface ThrowingTriConsumer extends TriConsumer {
  @Override
  default void accept(final T t, final U u, final V v) {
    try {
      acceptThrows(t, u, v);
    }
    catch (final Exception e) {
      Throwing.rethrow(e);
    }
  }

  /**
   * Performs this operation on the given argument, allowing an exception to be
   * thrown.
   *
   * @param t The first input argument.
   * @param u The second input argument.
   * @param v The third input argument.
   * @throws E If an exception has occurred.
   */
  void acceptThrows(T t, U u, V v) throws E;
}