git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.heos.internal.handler;
  14
  15 import java.util.concurrent.Future;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19
  20 /**
  21  * Instead of continously rewriting the termination of future a small util method was added
  22  *
  23  * @author Martin van Wingerden - Initial Contribution
  24  */
  25 @NonNullByDefault
  26 public class FutureUtil {
  27     private FutureUtil() {
  28         // this is a util no instances should be created
  29     }
  30
  31     /**
  32      * Cancel the future
  33      *
  34      * - when it is not null
  35      * - and it is not already cancelled
  36      *
  37      * interrupt if still/already running
  38      *
  39      * @param future nullable future to be cancelled
  40      */
  41     public static void cancel(@Nullable Future<?> future) {
  42         cancel(future, true);
  43     }
  44
  45     /**
  46      * Cancel the future
  47      *
  48      * - when it is not null
  49      * - and it is not already cancelled
  50      *
  51      * @param future nullable future to be cancelled
  52      * @param interruptIfRunning choose whether to interrupt a running future
  53      */
  54     public static void cancel(@Nullable Future<?> future, boolean interruptIfRunning) {
  55         if (future != null && !future.isCancelled()) {
  56             future.cancel(interruptIfRunning);
  57         }
  58     }
  59 }