4
votes

For the sake of argument, let's say I'm implementing Future for a task which is not cancelable. The Java 6 API doc says:

After [cancel()] returns, subsequent calls to isDone() will always return true.

[cancel()] returns false if the task could not be cancelled, typically because it has already completed normally

It also says:

[isDone()] returns true if this task completed.

But what if my cancellation fails not because the task is already completed, but because it simply cannot be cancelled? Is there a way out of this contradiction (other than making my uncancelable task cancelable and sidestepping it altogether)?

1
You missed the qualification of "completed": Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true. - Mark Peters
It's also relevant to cite Future.cancel(boolean): This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. So it seems legit to fail to cancel for whatever reason you want. - Mark Peters

1 Answers

1
votes

It does seem like the doc should say

After cancel() returns true, subsequent calls to isDone()...

The Javadocs are often flat-out wrong and contradictory, and Sun has often not even bothered to fix them even after 10 years. Careful testing should always supplement the docs.