Package io.codemodder

Class RegexFileChanger

java.lang.Object

io.codemodder.RawFileChanger

io.codemodder.RegexFileChanger

All Implemented Interfaces:

CodeChanger

public abstract class RegexFileChanger
extends RawFileChanger

This type does the heavy lifting for many protections that can work in a simple "search-and-replace" pattern for non-Java code.

Field Summary

Fields inherited from class io.codemodder.RawFileChanger

reporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegexFileChanger(Predicate<Path> fileMatcher, Pattern pattern, boolean removeEmptyLeftoverLines, List<DependencyGAV> dependenciesRequired)
protected	RegexFileChanger(Predicate<Path> fileMatcher, Pattern pattern, boolean removeEmptyLeftoverLines, List<DependencyGAV> dependenciesRequired, CodemodReporterStrategy reporter)

Method Summary

Modifier and Type	Method	Description
abstract String	getReplacementFor(String matchingSnippet)	Given a snippet that matches the regex, return the replacement string.
List<CodemodChange>	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

Constructor Details

RegexFileChanger

protected RegexFileChanger(Predicate<Path> fileMatcher,
 Pattern pattern,
 boolean removeEmptyLeftoverLines,
 List<DependencyGAV> dependenciesRequired)

RegexFileChanger

protected RegexFileChanger(Predicate<Path> fileMatcher,
 Pattern pattern,
 boolean removeEmptyLeftoverLines,
 List<DependencyGAV> dependenciesRequired,
 CodemodReporterStrategy reporter)

Method Details

visitFile

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

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

Throws:

IOException

getReplacementFor

public abstract String getReplacementFor(String matchingSnippet)

Given a snippet that matches the regex, return the replacement string. Some weavers will just delete the snippet, others will wrap it in something, etc.