Package io.codemodder

Class RawFileChanger

java.lang.Object

io.codemodder.RawFileChanger

All Implemented Interfaces:

CodeChanger

Direct Known Subclasses:

RegexFileChanger, SarifPluginRawFileChanger

public abstract class RawFileChanger
extends Object
implements CodeChanger

Gives access to raw files for performing arbitrary changes.

Field Summary

Fields

Modifier and Type	Field	Description
protected CodemodReporterStrategy	reporter

Constructor Summary

Constructors

Constructor	Description
RawFileChanger()
RawFileChanger(CodemodReporterStrategy reporter)

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.
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>	visitFile(CodemodInvocationContext context)	Visit a file.

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

RawFileChanger

public RawFileChanger()

RawFileChanger

public RawFileChanger(CodemodReporterStrategy reporter)

Method Details

visitFile

public abstract List<CodemodChange> visitFile(CodemodInvocationContext context)
                                       throws IOException

Visit a file. It is up to the subtype to make sure the file is something to be changed and perform all the changing.

Returns:

a list of changes that were made to the file

Throws:

IOException

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