org.opentcs.util.CallWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.util;

import java.util.concurrent.Callable;

/**
 * Provides methods for wrapping other method calls.
 * This can be useful to ensure preparations have been done for a larger set of various method
 * calls, for example.
 *
 * @author Martin Grzenia (Fraunhofer IML)
 */
public interface CallWrapper {

  /**
   * Calls a method that has a return value.
   *
   * @param  The return value's type.
   * @param callable The method wrapped in a {@link Callable} instance.
   * @return The result of the method's call.
   * @throws Exception If there was an exception calling method.
   */
   R call(Callable callable)
      throws Exception;

  /**
   * Calls a mehtod that has no return value.
   *
   * @param runnable The method wrapped in a {@link Runnable} instance.
   * @throws Exception If there was an exception calling method.
   */
  void call(Runnable runnable)
      throws Exception;
}