io.codemodder.Parameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codemodder-base Show documentation

Base framework for writing codemods in Java

There is a newer version: 0.98.6

package io.codemodder;

import java.nio.file.Path;

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

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

  /** Get the name of the variable. */
  String getName();

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

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

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

  /** Get the default value of the codemod parameter. */
  String getDefaultValue();
}