scalafix.interfaces

Enum ScalafixError

java.lang.Object

java.lang.Enum<ScalafixError>

scalafix.interfaces.ScalafixError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScalafixError>

public enum ScalafixError
extends java.lang.Enum<ScalafixError>

A code representing a category of errors that happen while running Scalafix.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CommandLineError A command-line argument parsed incorrectly.
LinterError A linter error was reported.
MissingSemanticdbError A semantic rewrite was run on a source file that has no associated META-INF/semanticdb/.../*.semanticdb.
NoFilesError No files were provided to Scalafix so nothing happened.
ParseError A source file failed to parse.
StaleSemanticdbError The source file contents on disk have changed since the last compilation with the SemanticDB compiler plugin.
TestError When run with ScalafixMainMode.TEST, this error is returned when a file on disk does not match the file contents if it was fixed with Scalafix.
UnexpectedError Something unexpected happened.

Method Summary

Modifier and Type	Method and Description
static ScalafixError	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScalafixError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UnexpectedError

public static final ScalafixError UnexpectedError

Something unexpected happened.

ParseError

public static final ScalafixError ParseError

A source file failed to parse.

CommandLineError

public static final ScalafixError CommandLineError

A command-line argument parsed incorrectly.

MissingSemanticdbError

public static final ScalafixError MissingSemanticdbError

A semantic rewrite was run on a source file that has no associated META-INF/semanticdb/.../*.semanticdb. Typical causes of this error include

• Incorrect --classpath, make sure the classpath is compiled with the SemanticDB compiler plugin
• Incorrect --sourceroot, if the classpath is compiled with a custom -P:semanticdb:sourceroot:{path} then make sure the provided --sourceroot is correct.

StaleSemanticdbError

public static final ScalafixError StaleSemanticdbError

The source file contents on disk have changed since the last compilation with the SemanticDB compiler plugin. To resolve this error re-compile the project and re-run Scalafix.

TestError

public static final ScalafixError TestError

When run with ScalafixMainMode.TEST, this error is returned when a file on disk does not match the file contents if it was fixed with Scalafix.

LinterError

public static final ScalafixError LinterError

A linter error was reported.

NoFilesError

public static final ScalafixError NoFilesError

No files were provided to Scalafix so nothing happened.

Method Detail

values

public static ScalafixError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScalafixError c : ScalafixError.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScalafixError valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null