scalafix.interfaces

Interface ScalafixFileEvaluation

public interface ScalafixFileEvaluation

Method Summary

Modifier and Type	Method and Description
ScalafixError[]	applyPatches()
ScalafixError[]	applyPatches(ScalafixPatch[] patches)
ScalafixDiagnostic[]	getDiagnostics()
java.util.Optional<ScalafixFileEvaluationError>	getError()
java.util.Optional<java.lang.String>	getErrorMessage()
ScalafixError[]	getErrors() Deprecated. replaced by getError()
java.nio.file.Path	getEvaluatedFile()
ScalafixRule[]	getEvaluatedRules()
ScalafixPatch[]	getPatches()
boolean	isSuccessful()
java.util.Optional<java.lang.String>	previewPatches()
java.util.Optional<java.lang.String>	previewPatches(ScalafixPatch[] patches)
java.util.Optional<java.lang.String>	previewPatchesAsUnifiedDiff()

Method Detail

isSuccessful

boolean isSuccessful()

Returns:

boolean true if scalafix was successfully evaluated on the file

getEvaluatedFile

java.nio.file.Path getEvaluatedFile()

Returns:

original path of the file scalafix has evaluated on

getEvaluatedRules

ScalafixRule[] getEvaluatedRules()

Returns:

corresponding list of rules that has been evaluated

getErrorMessage

java.util.Optional<java.lang.String> getErrorMessage()

getError

java.util.Optional<ScalafixFileEvaluationError> getError()

getErrors

@Deprecated
ScalafixError[] getErrors()

Deprecated. replaced by getError()

getDiagnostics

ScalafixDiagnostic[] getDiagnostics()

previewPatchesAsUnifiedDiff

java.util.Optional<java.lang.String> previewPatchesAsUnifiedDiff()

Returns:

if the fixed file is different from the input file and the evaluation is successful this method return non empty unified diff. The original file will stay unchanged.

getPatches

ScalafixPatch[] getPatches()

previewPatches

java.util.Optional<java.lang.String> previewPatches()

Returns:

It returns the new content of the file after scalafix has been evaluated on it if no error. The original file will stay unchanged.

applyPatches

ScalafixError[] applyPatches()

Returns:

apply all patches and write the result to file.

previewPatches

java.util.Optional<java.lang.String> previewPatches(ScalafixPatch[] patches)

Returns:

It returns the new content file after applying the desired patches if no error. The original file will stay unchanged.

applyPatches

ScalafixError[] applyPatches(ScalafixPatch[] patches)

Parameters:

patches - the patches should belong to this scalafixFileEvaluation's patches. If you apply patches that result from another ScalafixFileEvaluation, no patch will be applied to the file.