com.github.chaosfirebolt.converter.api.cache.storage.Computation Maven / Gradle / Ivy

Go to download
package com.github.chaosfirebolt.converter.api.cache.storage;

import java.util.Objects;
import java.util.function.Function;

/**
 * Represents a computation - function accepting one argument and producing a result.
 *
 * @param  type of the input
 * @param  type of the output
 * @since 3.3.0
 */
@FunctionalInterface
public interface Computation {

  /**
   * Applies the computation to the argument.
   *
   * @param input the argument
   * @return computed result
   */
  O compute(I input);

  /**
   * Adapts this {@link Computation} as a {@link Function}.
   *
   * @return this computation adapted as a function
   */
  default Function unwrap() {
    return unwrap(this);
  }

  /**
   * Adapts a {@link Function} as a {@link Computation}.
   *
   * @param function function to adapt
   * @param       type of the input
   * @param       type of the result
   * @return the function adapted as computation.
   * @throws NullPointerException if function is null
   */
  static  Computation wrap(Function function) {
    return new FunctionAdapter<>(Objects.requireNonNull(function, "Null function"));
  }

  /**
   * Adapts a {@link Computation} as a {@link Function}.
   *
   * @param computation computation to adapt
   * @param          type of the input
   * @param          type of the result
   * @return the computation adapted as a function
   * @throws NullPointerException if computation is null
   */
  static  Function unwrap(Computation computation) {
    return Objects.requireNonNull(computation, "Null computation")::compute;
  }
}