Package io.codemodder

Class SarifPluginJavaParserChanger<T extends com.github.javaparser.ast.Node>

java.lang.Object

io.codemodder.javaparser.JavaParserChanger

io.codemodder.SarifPluginJavaParserChanger<T>

All Implemented Interfaces:

CodeChanger

public abstract class SarifPluginJavaParserChanger<T extends com.github.javaparser.ast.Node>
extends JavaParserChanger

Provides base functionality for making JavaParser-based changes based on results found by a sarif file.

Field Summary

Fields

Modifier and Type	Field	Description
final RuleSarif	sarif

Fields inherited from class io.codemodder.javaparser.JavaParserChanger

reporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, CodemodReporterStrategy codemodReporterStrategy)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, RegionNodeMatcher regionNodeMatcher)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, RegionNodeMatcher regionNodeMatcher, CodemodReporterStrategy reporterStrategy)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor, RegionNodeMatcher regionNodeMatcher)
protected	SarifPluginJavaParserChanger(RuleSarif sarif, Class<? extends com.github.javaparser.ast.Node> nodeType, SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor, RegionNodeMatcher regionNodeMatcher, CodemodReporterStrategy reporter)

Method Summary

Modifier and Type	Method	Description
abstract ChangesResult	onResultFound(CodemodInvocationContext context, com.github.javaparser.ast.CompilationUnit cu, T node, com.contrastsecurity.sarif.Result result)	Creates a visitor for the given context and locations.
boolean	shouldRun()	A lifecycle event that is called before any files are processed.
boolean	supports(Path file)	A predicate which dictates if the file should be inspected by the codemod.
CodemodFileScanningResult	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 io.codemodder.javaparser.JavaParserChanger

getDescription, getIncludesExcludesPattern, getIndividualChangeDescription, getReferences, getSummary

Methods inherited from class java.lang.Object

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

Field Details

sarif

public final RuleSarif sarif

Constructor Details

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 CodemodReporterStrategy codemodReporterStrategy)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 RegionNodeMatcher regionNodeMatcher)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 RegionNodeMatcher regionNodeMatcher,
 CodemodReporterStrategy reporterStrategy)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor,
 RegionNodeMatcher regionNodeMatcher)

SarifPluginJavaParserChanger

protected SarifPluginJavaParserChanger(RuleSarif sarif,
 Class<? extends com.github.javaparser.ast.Node> nodeType,
 SourceCodeRegionExtractor<com.contrastsecurity.sarif.Result> regionExtractor,
 RegionNodeMatcher regionNodeMatcher,
 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.

Specified by:

supports in interface CodeChanger

Overrides:

supports in class JavaParserChanger

visit

public CodemodFileScanningResult visit(CodemodInvocationContext context,
 com.github.javaparser.ast.CompilationUnit cu)

Description copied from class: JavaParserChanger

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

Specified by:

visit in class JavaParserChanger

shouldRun

public boolean shouldRun()

Description copied from interface: CodeChanger

A lifecycle event that is called before any files are processed. This is a good place to short circuit if you don't have the necessary resources (e.g., SARIF).

onResultFound

public abstract ChangesResult onResultFound(CodemodInvocationContext context,
 com.github.javaparser.ast.CompilationUnit cu,
 T node,
 com.contrastsecurity.sarif.Result result)

Creates a visitor for the given context and locations.

Parameters:

context - the context of this files transformation

cu - the parsed model of the file being transformed

node - the node to act on

result - the given SARIF result to act on

Returns:

ChangesResult, that contains result changes