Async Naming Suffix (ARCH4026)

Key java.async.async-method-suffix · Severity info · Category async

Retired

This rule has been retired and is no longer checked: the collector does not run it and no new finding carries this code. The page is kept for reference and for findings recorded before it was retired.

Methods returning a CompletableFuture should be named per the language idiom (e.g. an Async suffix) so callers see at the call site that the result must be awaited.

Incorrect

public CompletableFuture<User> load(long id) {   // no suffix
    return repository.findById(id);
}

Correct

public CompletableFuture<User> loadAsync(long id) {
    return repository.findById(id);
}

Fix

Add an Async suffix to methods returning a CompletableFuture so the asynchronous contract is visible at the call site.