scalafix.interfaces

Interface Scalafix

public interface Scalafix

Public API for reflectively invoking Scalafix from a build tool or IDE integration. To obtain an instance of Scalafix, use classloadInstance(ClassLoader).

Method Summary

Modifier and Type	Method and Description
static Scalafix	classloadInstance(java.lang.ClassLoader classLoader) JVM runtime reflection method helper to classload an instance of Scalafix.
java.lang.String	mainHelp(int screenWidth) Get --help message for running the Scalafix command-line interface.
ScalafixMainArgs	newMainArgs()
java.lang.String	scala211() The most recent Scala 2.11 version in supportedScalaVersions()
java.lang.String	scala212() The most recent Scala 2.12 version in supportedScalaVersions()
java.lang.String	scalafixVersion() The release version of the current Scalafix API instance.
java.lang.String	scalametaVersion() The recommended Scalameta version to match the current Scalafix API instance.
java.lang.String[]	supportedScalaVersions() The exact Scala versions that are supported by the recommended scalametaVersion()

Method Detail

newMainArgs

ScalafixMainArgs newMainArgs()

Returns:

Construct a new instance of ScalafixMainArgs that can be later passed to #runMain(ScalafixMainArgs) .

mainHelp

java.lang.String mainHelp(int screenWidth)

Get --help message for running the Scalafix command-line interface.

Parameters:

screenWidth - The width of the screen, used for wrapping long sentences into multiple lines.

Returns:

The help message as a string.

scalafixVersion

java.lang.String scalafixVersion()

The release version of the current Scalafix API instance.

scalametaVersion

java.lang.String scalametaVersion()

The recommended Scalameta version to match the current Scalafix API instance.

supportedScalaVersions

java.lang.String[] supportedScalaVersions()

The exact Scala versions that are supported by the recommended scalametaVersion()

scala211

java.lang.String scala211()

The most recent Scala 2.11 version in supportedScalaVersions()

scala212

java.lang.String scala212()

The most recent Scala 2.12 version in supportedScalaVersions()

classloadInstance

static Scalafix classloadInstance(java.lang.ClassLoader classLoader)
                           throws ScalafixException

JVM runtime reflection method helper to classload an instance of Scalafix.

Parameters:

classLoader - Classloader containing the full Scalafix classpath, including the scalafix-cli module.

Returns:

An implementation of the Scalafix interface.

Throws:

ScalafixException - in case of errors during classloading, most likely caused by an incorrect classloader argument.