What is the list of valid @SuppressWarnings warning names in Java?

java

best-practices

ide

warnings

byAlex Kataev·Nov 10, 2024

Use @SuppressWarnings with these common keys:

deprecation: Quiets the old grumpy API warnings.
unchecked: Covers your back on unchecked type operations, especially with generics.
rawtypes: Keeps raw types in generics warnings at bay.
serial: Helps when serialVersionUID is missing from serializable classes.
fallthrough: Allows case blocks in switches to break-free.
varargs: Safe-guards against varargs-related heap pollution.

Code snippet for the brave:

@SuppressWarnings({"unchecked", "deprecation"})
void indy500() {
    // When you're not afraid of a little speed...or warnings
}

Remember, consult your specific compiler or toolset as warning names differ.

Taming the IDE and Compiler Beasts

Navigating the IDE Minefield

While some warning names like unchecked and deprecation are universal in Java, others differ between IDEs and compilers.

Eclipse has a lengthy warning list that outpaces Sun JDK. Each version, i.e., Galileo, Indigo, Juno, Kepler and Luna, added more suppressible warnings.

IntelliJ IDEA users luxuriate in convenience — Alt-Enter brings up @SuppressWarnings suggestions based on context.

Reading the Compiler's Mind

Executing javac -X lists all recognized warning names for your compiler — it's like reading its mind. But, always consult your compiler's documentation for an accurate list, as warning names can be compiler-specific.

Aiding Code Quality

Use @SuppressWarnings to improve code quality by blocking nonessential warnings, but only after conscious consideration.

Mastering Alert Suppression

Suppress with Wisdom

Only suppress warnings that are understood and deemed acceptable. @SuppressWarnings("all") offers full suppression but use it judiciously—it mutes all warnings, potentially masking issues.

Let IDEs Work for You

Many modern IDEs, like IntelliJ IDEA, have a "Suppress for ..." feature, acting as an experienced guide that efficiently leads you through the jungle of warnings.

Beyond @SuppressWarnings

Other annotations like @VisibleForTesting communicate intent more explicitly. This reveals to other devs and tools that the code is more permissive due to testing.

explain-codes / Java / What is the list of valid @SuppressWarnings warning names in Java?

Linked

Combining multiple @SuppressWarnings annotations - Eclipse Indigo



Class JavaLaunchHelper is implemented in two places



'must Override a Superclass Method' Errors after importing a project into Eclipse



Access restriction on class due to restriction on required library rt.jar?



What is SuppressWarnings ("unchecked") in Java?

