Dead code: unreachable null check on @Parameter(required=true) in ToolchainMojo

Open Beginner friendly
#175 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Quiet
Tech stack
java
Domain
build-system

Research direction

Open src/main/java/org/apache/maven/plugins/toolchain/ToolchainMojo.java and inspect ToolchainMojo.execute() around lines 58-61. Remove the null-check block for the required toolchains parameter, then verify the plugin still builds and its existing checks pass.

Written by the indexing model from the issue text.

Description

Summary

ToolchainMojo.execute() contains a null check on the toolchains field that is annotated with @Parameter(required = true). Maven enforces required parameters before the mojo executes, making this check dead code.

Location

ToolchainMojo.java:58-61

https://github.com/apache/maven-toolchains-plugin/blob/master/src/main/java/org/apache/maven/plugins/toolchain/ToolchainMojo.java#L58-L61

Code

@Parameter(required = true)
private ToolchainsRequirement toolchains;

@Override
public void execute() throws MojoExecutionException, MojoFailureException {
    if (toolchains == null) {
        // should not happen since parameter is required...
        getLog().warn("No toolchains requirements configured.");
        return;
    }
    // ...
}

Problem

  1. @Parameter(required = true) means Maven will fail the build with an error if the toolchains configuration is not provided
  2. The null check guard is unreachable because execution never reaches the mojo if a required parameter is missing
  3. The comment // should not happen since parameter is required... confirms the developer knew this was dead code
  4. If it did somehow execute, silently returning with just a warning is the wrong behavior for a missing required config

Impact

Dead code increases maintenance burden and gives a false impression that the plugin handles missing configuration gracefully (it doesn't - Maven handles it beforehand).

Suggested Fix

Remove the null check block entirely.

Dominant language
Java
Stars
27
Forks
31
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/maven-toolchains-plugin

All issues in apache/maven-toolchains-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.