Package io.codemodder.javaparser

Class JavaParserChanger

java.lang.Object

io.codemodder.javaparser.JavaParserChanger

All Implemented Interfaces:

CodeChanger

Direct Known Subclasses:

CompositeJavaParserChanger, SarifPluginJavaParserChanger

public abstract class JavaParserChanger
extends Object
implements CodeChanger

Uses JavaParser to change Java source files.

Field Summary

Fields

Modifier and Type	Field	Description
protected CodemodReporterStrategy	reporter

Constructor Summary

Constructors

Constructor	Description
JavaParserChanger()
JavaParserChanger(CodemodReporterStrategy reporter)

Method Summary

Modifier and Type	Method	Description
List<DependencyGAV>	dependenciesRequired()	Return the list of dependencies associated with the "fix" provided by this changer.
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.
Optional<String>	getSourceControlUrl()	The URL of the source code of the security control API added in this change, if any.
String	getSummary()	The headline for this codemod's changes.
abstract List<CodemodChange>	visit(CodemodInvocationContext context, com.github.javaparser.ast.CompilationUnit cu)	Called when a Java file, which has already been parsed into a compilation unit, is seen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

reporter

protected CodemodReporterStrategy reporter

Constructor Details

JavaParserChanger

public JavaParserChanger()

JavaParserChanger

public JavaParserChanger(CodemodReporterStrategy reporter)

Method Details

visit

public abstract List<CodemodChange> visit(CodemodInvocationContext context,
 com.github.javaparser.ast.CompilationUnit cu)

Called when a Java file, which has already been parsed into a compilation unit, is seen.

dependenciesRequired

public List<DependencyGAV> dependenciesRequired()

Return the list of dependencies associated with the "fix" provided by this changer.

getSummary

public String getSummary()

Description copied from interface: CodeChanger

The headline for this codemod's changes.

Specified by:

getSummary in interface CodeChanger

getDescription

public String getDescription()

Description copied from interface: CodeChanger

A deep description of what this codemod's changes.

Specified by:

getDescription in interface CodeChanger

getIndividualChangeDescription

public String getIndividualChangeDescription(Path filePath,
 CodemodChange change)

Description copied from interface: CodeChanger

A description of an individual change made by this codemod.

Specified by:

getIndividualChangeDescription in interface CodeChanger

getReferences

public List<io.codemodder.codetf.CodeTFReference> getReferences()

Description copied from interface: CodeChanger

A list of references for further reading on the issues this codemod addresses or other supplementary information.

Specified by:

getReferences in interface CodeChanger

getSourceControlUrl

public Optional<String> getSourceControlUrl()

Description copied from interface: CodeChanger

The URL of the source code of the security control API added in this change, if any.

Specified by:

getSourceControlUrl in interface CodeChanger