Package io.codemodder

Interface Parameter

public interface Parameter
A parameter for a codemod, capable of retrieving the right value for a given path and line.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultValue()
    Get the default value of the codemod parameter.
    String
    getLabel()
    Get a description of the codemod parameter.
    String
    getName()
    Get the name of the variable.
    String
    getQuestion()
    Get the question to ask the user for the value.
    String
    getType()
    Get the type of parameter, should be "string", "number", or "boolean".
    String
    getValue(Path path, int currentLine)
    Get the value of a given codemod parameter for the given path and line.

  • Method Details

    • getQuestion

      String getQuestion()
      Get the question to ask the user for the value.

    • getName

      String getName()
      Get the name of the variable.

    • getType

      String getType()
      Get the type of parameter, should be "string", "number", or "boolean".

    • getValue

      String getValue(Path path, int currentLine)
      Get the value of a given codemod parameter for the given path and line.

    • getLabel

      String getLabel()
      Get a description of the codemod parameter.

    • getDefaultValue

      String getDefaultValue()
      Get the default value of the codemod parameter.