org.helenus.util.function.TetraConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helenus-commons Show documentation

JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - Common Utilities

There is a newer version: 3.0.4

/*
 * Copyright (C) 2015-2015 The Helenus Driver Project Authors.
 *
 * 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.helenus.util.function;

import java.util.function.Consumer;

/**
 * The TetraConsumer interface represents an operation that accepts
 * four input arguments and returns no result. This is the four-arity
 * specialization of {@link Consumer}. Unlike most other functional interfaces,
 * TetraConsumer is expected to operate via side-effects.
 * 
 * This is a functional interface
 * whose functional method is {@link #accept(Object, Object, Object, Object)}.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Jul 9, 2015 - paouelle - Creation
 *
 * @param  the type of the first argument to the operation
 * @param  the type of the second argument to the operation
 * @param  the type of the third argument to the operation
 * @param  the type of the fourth argument to the operation
 *
 * @since 2.0
 */
@FunctionalInterface
public interface TetraConsumer {
  /**
   * Performs this operation on the given arguments.
   *
   * @author paouelle
   *
   * @param t the first input argument
   * @param u the second input argument
   * @param v the third input argument
   * @param x the fourth input argument
   */
  public void accept(T t, U u, V v, X x);

  /**
   * Returns a composed {@code TetraConsumer} 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.
   *
   * @author paouelle
   *
   * @param  after the operation to perform after this operation
   * @return a composed {@code TetraConsumer} that performs in sequence this
   *         operation followed by the {@code after} operation
   * @throws NullPointerException if {@code after} is null
   */
  public default TetraConsumer andThen(
    TetraConsumer after
  ) {
    org.apache.commons.lang3.Validate.notNull(after, "invalid null after");
    return (l, m, r, f) -> {
      accept(l, m, r, f);
      after.accept(l, m, r, f);
    };
  }
}