Package io.codemodder.codetf

Class CodeTFResult

java.lang.Object

io.codemodder.codetf.CodeTFResult

public final class CodeTFResult
extends Object

Describes the "result" section of a CodeTF document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CodeTFResult.Builder	Builder for CodeTFResult which was based on an existing instance.

Constructor Summary

Constructors

Constructor	Description
CodeTFResult(String codemod, String summary, String description, DetectionTool detectionTool, Failure failure, Set<String> failedFiles, List<CodeTFReference> references, Map<String,String> properties, List<CodeTFChangesetEntry> changeset, List<UnfixedFinding> unfixedFindings)
CodeTFResult(String codemod, String summary, String description, List<CodeTFChangesetEntry> changeset)	Constructor for required (non-nullable) fields

Method Summary

Modifier and Type	Method	Description
static CodeTFResult.Builder	basedOn(CodeTFResult result)	Create a new CodeTFResult builder based on an existing instance.
boolean	failed()
List<CodeTFChangesetEntry>	getChangeset()
String	getCodemod()
String	getDescription()
DetectionTool	getDetectionTool()
Set<String>	getFailedFiles()
Failure	getFailure()
List<FixedFinding>	getFixedFindings()
Map<String,String>	getProperties()
List<CodeTFReference>	getReferences()
String	getSummary()
List<UnfixedFinding>	getUnfixedFindings()
boolean	usesAi()

Methods inherited from class java.lang.Object

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

Constructor Details

CodeTFResult

public CodeTFResult(String codemod,
 String summary,
 String description,
 DetectionTool detectionTool,
 Failure failure,
 Set<String> failedFiles,
 List<CodeTFReference> references,
 Map<String,String> properties,
 List<CodeTFChangesetEntry> changeset,
 List<UnfixedFinding> unfixedFindings)

CodeTFResult

public CodeTFResult(String codemod,
 String summary,
 String description,
 List<CodeTFChangesetEntry> changeset)

Constructor for required (non-nullable) fields

Method Details

getCodemod

public String getCodemod()

getSummary

public String getSummary()

getDescription

public String getDescription()

getDetectionTool

public DetectionTool getDetectionTool()

getFailure

public Failure getFailure()

failed

public boolean failed()

getFailedFiles

public Set<String> getFailedFiles()

getReferences

public List<CodeTFReference> getReferences()

getProperties

public Map<String,String> getProperties()

getChangeset

public List<CodeTFChangesetEntry> getChangeset()

getUnfixedFindings

public List<UnfixedFinding> getUnfixedFindings()

usesAi

public boolean usesAi()

getFixedFindings

public List<FixedFinding> getFixedFindings()

basedOn

public static CodeTFResult.Builder basedOn(CodeTFResult result)

Create a new CodeTFResult builder based on an existing instance.