Package io.codemodder.codetf

Class CodeTFReport

java.lang.Object

io.codemodder.codetf.CodeTFReport

public final class CodeTFReport
extends Object

Top level reporting object for CodeTF v2. This is the root object to be deserialized from an input stream.

Applications should deserialize this object using a centralized ObjectMapper:

 ObjectMapper mapper = new ObjectMapper();
 // Configure the mapper as needed
 CodeTFReport report = mapper.readValue(inputStream, CodeTFReport.class);
 

Constructor Summary

Constructors

Constructor	Description
CodeTFReport(CodeTFRun run, List<CodeTFResult> results)

Method Summary

Modifier and Type	Method	Description
List<CodeTFResult>	getResults()	Return a List of individual codemod's results.
CodeTFRun	getRun()
boolean	hasCodeChanges()	Returns true if the CodeTF describes any changes made to the code.

Methods inherited from class java.lang.Object

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

Constructor Details

CodeTFReport

public CodeTFReport(CodeTFRun run,
 List<CodeTFResult> results)

Method Details

getRun

public CodeTFRun getRun()

getResults

public List<CodeTFResult> getResults()

Return a List of individual codemod's results. If this list is not empty, that does not mean there are changes to make.

hasCodeChanges

public boolean hasCodeChanges()

Returns true if the CodeTF describes any changes made to the code.