scalafix.interfaces

Enum ScalafixMainMode

java.lang.Object

java.lang.Enum<ScalafixMainMode>

scalafix.interfaces.ScalafixMainMode

All Implemented Interfaces:

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

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

The mode for running the command-line interface.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_SUPPRESS_LINTER_ERRORS Instead of reporting linter error messages, write suppression comments in-place.
CHECK Report error if fixed contents does not match original file contents.
IN_PLACE Default value, write fixed contents in-place.
IN_PLACE_TRIGGERED Use when the client triggers the run as a side effect of something else, as opposed to an explicit, interactive invocation.
STDOUT Print fixed output to stdout.

Method Summary

Modifier and Type	Method and Description
static ScalafixMainMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScalafixMainMode[]	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

IN_PLACE

public static final ScalafixMainMode IN_PLACE

Default value, write fixed contents in-place.

CHECK

public static final ScalafixMainMode CHECK

Report error if fixed contents does not match original file contents. Does not write to files.

STDOUT

public static final ScalafixMainMode STDOUT

Print fixed output to stdout. Does not write to files.

AUTO_SUPPRESS_LINTER_ERRORS

public static final ScalafixMainMode AUTO_SUPPRESS_LINTER_ERRORS

Instead of reporting linter error messages, write suppression comments in-place.

IN_PLACE_TRIGGERED

public static final ScalafixMainMode IN_PLACE_TRIGGERED

Use when the client triggers the run as a side effect of something else, as opposed to an explicit, interactive invocation. Write fixed contents in-place, with a custom configuration if it exists.

Method Detail

values

public static ScalafixMainMode[] 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 (ScalafixMainMode c : ScalafixMainMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScalafixMainMode 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