dev.jeka.core.api.kotlin

Class JkKotlinCompiler

java.lang.Object

dev.jeka.core.api.kotlin.JkKotlinCompiler

public final class JkKotlinCompiler
extends java.lang.Object

Represents a Kotlin compiler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkKotlinCompiler.Target Represents the possible target platforms for the Kotlin compiler.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KOTLIN_COMPILER_COORDINATES
static JkPathMatcher	KOTLIN_SOURCE_MATCHER
static java.lang.String	KOTLIN_VERSION_OPTION

Method Summary

Modifier and Type	Method and Description
JkKotlinCompiler	addJvmOption(java.lang.String option) Adds JVM options to pass to compiler program (which is a Java program).
JkKotlinCompiler	addOption(java.lang.String option) Adds an option to the Kotlin compiler.
JkKotlinCompiler	addPlugin(java.nio.file.Path pluginJar) Adds a plugin JAR file to the Kotlin compiler.
JkKotlinCompiler	addPlugin(java.lang.String coordinate) Instructs this compiler to use the plugin identified by the specified coordinates.
JkKotlinCompiler	addPluginOption(java.lang.String pluginId, java.lang.String name, java.lang.String value) Adds a plugin option to the Kotlin compiler.
boolean	compile(JkKotlinJvmCompileSpec compileSpec) Compiles the source files to the output directory.
java.util.List<java.lang.String>	getPluginOptions() Returns the list of plugin options used by this compiler.
java.util.List<java.lang.String>	getPlugins() Returns the list of plugins used by this compiler.
JkRepoSet	getRepos() Retrieves the set of repositories to fetch stdlib and plugins.
JkPathSequence	getStdJdk8Lib() Returns the path of the standard JDK 8 libraries for the Kotlin compiler.
java.nio.file.Path	getStdLib() Returns path of stdlib located in JEKA_HOME (if the compiler is provided by the platform) of from a repo (if the compiler is managed by JeKa, meaning the version is specified)
java.lang.String	getVersion() Returns the version of Kotlin this compiler stands for.
boolean	isProvidedCompiler() Returns true if this compiler is provided by the host machine, meaning it has not been downloaded and managed by Jeka.
static JkKotlinCompiler	ofCommand(java.lang.String command) Creates a JkKotlinCompiler based on the specified command.
static JkKotlinCompiler	ofJvm(JkRepoSet repos) Creates a JkKotlinCompiler for JVM with the specified by 'jeka.kotlin.version' property and fetched from the specified repository.
static JkKotlinCompiler	ofJvm(JkRepoSet repos, java.lang.String version) Creates a JkKotlinCompiler for JVM with the specified version and fetched from the specified repository .
static JkKotlinCompiler	ofKotlinHomeCommand(java.lang.String command) Creates a JkKotlinCompiler based on the specified command located in `KOTLIN_HOME` directory.
static JkKotlinCompiler	ofTarget(JkRepoSet repos, JkKotlinCompiler.Target target, java.lang.String kotlinVersion) Creates a JkKotlinCompiler of the specified Kotlin version for the specified target platform.
JkKotlinCompiler	setFailOnError(boolean fail) Sets the flag to indicate whether compilation should fail on error or not.
JkKotlinCompiler	setLogCommand(boolean log) Sets the flag to indicate whether the compiler command should be logged or not.
JkKotlinCompiler	setLogOutput(boolean log) Sets the flag to indicate whether the compiler output should be logged or not.
JkKotlinCompiler	setRepos(JkRepoSet repos) Set the repo to fetch stdlib and plugins.

Methods inherited from class java.lang.Object

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

Field Detail

KOTLIN_COMPILER_COORDINATES

public static final java.lang.String KOTLIN_COMPILER_COORDINATES

See Also:

Constant Field Values

KOTLIN_VERSION_OPTION

public static final java.lang.String KOTLIN_VERSION_OPTION

See Also:

Constant Field Values

KOTLIN_SOURCE_MATCHER

public static final JkPathMatcher KOTLIN_SOURCE_MATCHER

Method Detail

ofCommand

public static JkKotlinCompiler ofCommand(java.lang.String command)

Creates a JkKotlinCompiler based on the specified command. The specified command is supposed to be accessible from the working directory. Examples of command are "kotlinc", "kotlinc-native", "/my/kotlin/home/kotlin-js", ...

ofKotlinHomeCommand

public static JkKotlinCompiler ofKotlinHomeCommand(java.lang.String command)

Creates a JkKotlinCompiler based on the specified command located in `KOTLIN_HOME` directory. Examples of command are "kotlinc", "kotlin-jvm", "kotlin-js".

ofTarget

public static JkKotlinCompiler ofTarget(JkRepoSet repos,
                                        JkKotlinCompiler.Target target,
                                        java.lang.String kotlinVersion)

Creates a JkKotlinCompiler of the specified Kotlin version for the specified target platform. The compiler matching the specified Kotlin version is downloaded from the specified repo.

ofJvm

public static JkKotlinCompiler ofJvm(JkRepoSet repos,
                                     java.lang.String version)

Creates a JkKotlinCompiler for JVM with the specified version and fetched from the specified repository .

Parameters:

repos - The repository set to download the Kotlin compiler from.

version - The version of Kotlin to use.

Throws:

java.lang.IllegalArgumentException - if `version` is null.

ofJvm

public static JkKotlinCompiler ofJvm(JkRepoSet repos)

Creates a JkKotlinCompiler for JVM with the specified by 'jeka.kotlin.version' property and fetched from the specified repository.

Parameters:

repos - The repository set to download the Kotlin compiler from.

isProvidedCompiler

public boolean isProvidedCompiler()

Returns true if this compiler is provided by the host machine, meaning it has not been downloaded and managed by Jeka.

getVersion

public java.lang.String getVersion()

Returns the version of Kotlin this compiler stands for. If this compiler is coming the hosting machine, this method returns null.

getStdLib

public java.nio.file.Path getStdLib()

Returns path of stdlib located in JEKA_HOME (if the compiler is provided by the platform) of from a repo (if the compiler is managed by JeKa, meaning the version is specified)

getStdJdk8Lib

public JkPathSequence getStdJdk8Lib()

Returns the path of the standard JDK 8 libraries for the Kotlin compiler.

setFailOnError

public JkKotlinCompiler setFailOnError(boolean fail)

Sets the flag to indicate whether compilation should fail on error or not.

setLogCommand

public JkKotlinCompiler setLogCommand(boolean log)

Sets the flag to indicate whether the compiler command should be logged or not.

setLogOutput

public JkKotlinCompiler setLogOutput(boolean log)

Sets the flag to indicate whether the compiler output should be logged or not.

getRepos

public JkRepoSet getRepos()

Retrieves the set of repositories to fetch stdlib and plugins.

setRepos

public JkKotlinCompiler setRepos(JkRepoSet repos)

Set the repo to fetch stdlib and plugins.

addJvmOption

public JkKotlinCompiler addJvmOption(java.lang.String option)

Adds JVM options to pass to compiler program (which is a Java program).

addPluginOption

public JkKotlinCompiler addPluginOption(java.lang.String pluginId,
                                        java.lang.String name,
                                        java.lang.String value)

Adds a plugin option to the Kotlin compiler.

addPlugin

public JkKotlinCompiler addPlugin(java.nio.file.Path pluginJar)

Adds a plugin JAR file to the Kotlin compiler.

addPlugin

public JkKotlinCompiler addPlugin(java.lang.String coordinate)

Instructs this compiler to use the plugin identified by the specified coordinates. If the coordinate does not mention the version, the Kotlin version of this compiler is chosen.

Plugin class provides constants about most common plugin coordinates.

addOption

public JkKotlinCompiler addOption(java.lang.String option)

Adds an option to the Kotlin compiler.

compile

public boolean compile(JkKotlinJvmCompileSpec compileSpec)

Compiles the source files to the output directory.

Returns:

false if a compilation error occurred.

Throws:

java.lang.IllegalStateException - if a compilation error occurred and the 'withFailOnError' flag is true.

getPlugins

public java.util.List<java.lang.String> getPlugins()

Returns the list of plugins used by this compiler.

getPluginOptions

public java.util.List<java.lang.String> getPluginOptions()

Returns the list of plugin options used by this compiler.