Package io.codemodder

Class SarifPluginRawFileChanger

java.lang.Object

io.codemodder.RawFileChanger

io.codemodder.SarifPluginRawFileChanger

All Implemented Interfaces:

CodeChanger

public abstract class SarifPluginRawFileChanger
extends RawFileChanger

A RawFileChanger bundled with a RuleSarif.

Field Summary

Fields inherited from class io.codemodder.RawFileChanger

reporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SarifPluginRawFileChanger(RuleSarif sarif)
protected	SarifPluginRawFileChanger(RuleSarif sarif, CodemodReporterStrategy reporter)

Method Summary

Modifier and Type	Method	Description
abstract CodemodFileScanningResult	onFileFound(CodemodInvocationContext context, List<com.contrastsecurity.sarif.Result> results)	Creates a visitor for the given context and results.
boolean	supports(Path file)	A predicate which dictates if the file should be inspected by the codemod.
CodemodFileScanningResult	visitFile(CodemodInvocationContext context)	Visit a file.

Methods inherited from class io.codemodder.RawFileChanger

getDescription, getIndividualChangeDescription, getReferences, getSummary

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.codemodder.CodeChanger

getIncludesExcludesPattern, shouldRun

Constructor Details

SarifPluginRawFileChanger

protected SarifPluginRawFileChanger(RuleSarif sarif)

SarifPluginRawFileChanger

protected SarifPluginRawFileChanger(RuleSarif sarif,
 CodemodReporterStrategy reporter)

Method Details

supports

public boolean supports(Path file)

Description copied from interface: CodeChanger

A predicate which dictates if the file should be inspected by the codemod. This cannot be overridden and should always pass before executing the codemod.

visitFile

public CodemodFileScanningResult visitFile(CodemodInvocationContext context)

Description copied from class: RawFileChanger

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

Specified by:

visitFile in class RawFileChanger

Returns:

a list of changes that were made to the file

onFileFound

public abstract CodemodFileScanningResult onFileFound(CodemodInvocationContext context,
 List<com.contrastsecurity.sarif.Result> results)

Creates a visitor for the given context and results.

Parameters:

context - the context of this files transformation

results - the given SARIF results to act on

Returns:

a List of CodemodChanges representing changes in the file.