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, Set<String> failedFiles, List<CodeTFReference> references, Map<String,String> properties, List<CodeTFChangesetEntry> changeset)

Method Summary

Modifier and Type	Method	Description
static CodeTFResult.Builder	basedOn(CodeTFResult result)	Create a new CodeTFResult builder based on an existing instance.
List<CodeTFChangesetEntry>	getChangeset()
String	getCodemod()
String	getDescription()
Set<String>	getFailedFiles()
Map<String,String>	getProperties()
List<CodeTFReference>	getReferences()
String	getSummary()

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeTFResult

public CodeTFResult(String codemod,
                    String summary,
                    String description,
                    Set<String> failedFiles,
                    List<CodeTFReference> references,
                    Map<String,String> properties,
                    List<CodeTFChangesetEntry> changeset)

Method Detail

getCodemod

public String getCodemod()

getSummary

public String getSummary()

getDescription

public String getDescription()

getFailedFiles

public Set<String> getFailedFiles()

getReferences

public List<CodeTFReference> getReferences()

getProperties

public Map<String,String> getProperties()

getChangeset

public List<CodeTFChangesetEntry> getChangeset()

basedOn

public static CodeTFResult.Builder basedOn(CodeTFResult result)

Create a new CodeTFResult builder based on an existing instance.