io.codemodder.codemods.MoveSwitchDefaultCaseLastCodemod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-codemods Show documentation

Codemods for fixing common errors across many Java projects

There is a newer version: 0.97.3

package io.codemodder.codemods;

import com.contrastsecurity.sarif.Result;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.stmt.SwitchEntry;
import com.github.javaparser.ast.stmt.SwitchStmt;
import io.codemodder.*;
import io.codemodder.javaparser.ChangesResult;
import io.codemodder.providers.sarif.pmd.PmdScan;
import javax.inject.Inject;

/**
 * A codemod for moving the "default" case to last in switch statements. This codemod is not
 * currently in the default set because it could conceivably change behavior when other case
 * statements fall through to it. It should be improved to only move if the previous case does not
 * fall through.
 */
@Codemod(
    id = "pixee:java/move-switch-default-last",
    importance = Importance.LOW,
    reviewGuidance = ReviewGuidance.MERGE_WITHOUT_REVIEW)
public final class MoveSwitchDefaultCaseLastCodemod
    extends SarifPluginJavaParserChanger {

  @Inject
  public MoveSwitchDefaultCaseLastCodemod(
      @PmdScan(ruleId = "category/java/bestpractices.xml/DefaultLabelNotLastInSwitchStmt")
          final RuleSarif ruleSarif) {
    super(ruleSarif, SwitchEntry.class, RegionNodeMatcher.MATCHES_START);
  }

  @Override
  public ChangesResult onResultFound(
      final CodemodInvocationContext context,
      final CompilationUnit cu,
      final SwitchEntry switchEntry,
      final Result result) {
    SwitchStmt switchStmt = (SwitchStmt) switchEntry.getParentNode().get();
    NodeList entries = switchStmt.getEntries();

    if (entries.size() == 1) {
      // don't mess with the default case if it's the only case
      return ChangesResult.noChanges;
    }
    entries.remove(switchEntry);
    entries.addLast(switchEntry);
    return ChangesResult.changesApplied;
  }
}