Package io.codemodder

Interface CodeChanger

All Known Implementing Classes:
CompositeJavaParserChanger, JavaParserChanger, RawFileChanger, RegexFileChanger, SarifPluginJavaParserChanger, SarifPluginRawFileChanger
public interface CodeChanger
The base of a codemod type.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A deep description of what this codemod's changes.
    String
    getIndividualChangeDescription(Path filePath, CodemodChange change)
    A description of an individual change made by this codemod.
    List<io.codemodder.codetf.CodeTFReference>
    getReferences()
    A list of references for further reading on the issues this codemod addresses or other supplementary information.
    String
    getSummary()
    The headline for this codemod's changes.
    default boolean
    shouldRun()
    A lifecycle event that is called before any files are processed.

  • Method Details

    • getSummary

      String getSummary()
      The headline for this codemod's changes.

    • getDescription

      String getDescription()
      A deep description of what this codemod's changes.

    • getReferences

      List<io.codemodder.codetf.CodeTFReference> getReferences()
      A list of references for further reading on the issues this codemod addresses or other supplementary information.

    • getIndividualChangeDescription

      String getIndividualChangeDescription(Path filePath, CodemodChange change)
      A description of an individual change made by this codemod.

    • shouldRun

      default boolean shouldRun()
      A lifecycle event that is called before any files are processed. This is a good place to short circuit if you don't have the necessary resources (e.g., SARIF).