Java : CancellationException with Examples

Published : May 31, 2023

日本語

CancellationException (Java SE 20 & JDK 20) API Examples.
You will find code examples on most CancellationException methods.

Summary

try (final var executorService = Executors.newSingleThreadExecutor()) {
    final var future = executorService.submit(() -> {
        try {
            System.out.println("task start");
            TimeUnit.SECONDS.sleep(2);

            return "abcd";
        } catch (InterruptedException e) {
            System.out.println("Interrupted!");
            return null;
        } finally {
            System.out.println("task end");
        }
    });

    TimeUnit.SECONDS.sleep(1);

    System.out.println("-- get start --");
    final var ret = future.get();

    System.out.println("-- get end --");
    System.out.println("ret = " + ret);
}

// Result
// ↓
//task start
//-- get start --
//task end
//-- get end --
//ret = abcd

try (final var executorService = Executors.newScheduledThreadPool(2)) {
    final var future = executorService.submit(() -> {
        try {
            System.out.println("task start");
            TimeUnit.SECONDS.sleep(3);

            return "abcd";
        } catch (InterruptedException e) {
            System.out.println("Interrupted!");
            return null;
        } finally {
            System.out.println("task end");
        }
    });

    executorService.schedule(() -> {
        System.out.println("future.cancel");
        future.cancel(true);
    }, 2, TimeUnit.SECONDS);

    try {
        System.out.println("-- get start --");
        final var ret = future.get();

        System.out.println("-- get end --");
        System.out.println("ret = " + ret);
    } catch (CancellationException e) {
        System.out.println("CancellationException!");
    }
}

// Result
// ↓
//task start
//-- get start --
//future.cancel
//Interrupted!
//CancellationException!
//task end

Constructors

final var e = new CancellationException();
System.out.println(e); // java.util.concurrent.CancellationException

final var e = new CancellationException("abcd");
System.out.println(e); // java.util.concurrent.CancellationException: abcd
System.out.println(e.getMessage()); // abcd

Methods declared in Throwable

Related posts

• Use TimeUnit.sleep instead of Thread.sleep

• API Examples
  • BlockingQueue
    • ArrayBlockingQueue
    • BlockingDeque
    • LinkedBlockingDeque
    • LinkedBlockingQueue
    • PriorityBlockingQueue
  • Callable
  • ConcurrentHashMap.KeySetView
  • ConcurrentLinkedDeque
  • ConcurrentLinkedQueue
  • ConcurrentMap
    • ConcurrentHashMap
    • ConcurrentSkipListMap
  • ConcurrentModificationException
  • ConcurrentSkipListSet
  • Condition
  • CopyOnWriteArrayList
  • CopyOnWriteArraySet
  • CountDownLatch
  • CyclicBarrier
  • Exchanger
  • Executor
  • ExecutorService
  • Executors
  • Future
  • Future.State
  • FutureTask
  • InterruptedException
  • Lock
    • ReentrantLock
  • Runnable
  • Semaphore
  • Thread
  • ThreadGroup
  • ThreadLocal
    • InheritableThreadLocal
  • TimeUnit