IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.tasks.aware/RunnableIdeAware

RunnableIdeAware

interface RunnableIdeAware : AutoReloadAware, CoroutinesJavaAgentAware, PluginAware, RuntimeAware, SandboxAware, JavaForkOptions

The interface which uses a set of various interfaces required for running a guest IDE.

See also

CoroutinesJavaAgentAware

AutoReloadAware

JavaForkOptions

Inheritors

BuildSearchableOptionsTask

TestIdePerformanceTask

Properties

@get:Internal

abstract var allJvmArgs: List<String?>?

@get:Internal

abstract val autoReload: Property<Boolean>

Enables auto-reload of dynamic plugins. Dynamic plugin will be reloaded automatically when its content is modified.

bootstrapClasspath

@get:Classpath

abstract var bootstrapClasspath: FileCollection?

coroutinesJavaAgentFile

@get:Internal

@get:Optional

abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

@get:Input

abstract var debug: Boolean

abstract val debugOptions: JavaDebugOptions?

defaultCharacterEncoding

@get:Optional

@get:Input

abstract var defaultCharacterEncoding: @Nullable String?

enableAssertions

@get:Input

abstract var enableAssertions: Boolean

abstract var environment: Map<String?, Any?>?

abstract var executable: String?

intelliJPlatformConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_DEPENDENCY configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

intelliJPlatformPluginConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

intelliJPlatformTestRuntimeFixClasspathConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformTestRuntimeFixClasspathConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_TEST_RUNTIME_FIX_CLASSPATH configuration with the custom IntelliJ Platform core dependency required for running tests. It should not be directly accessed.

jetbrainsRuntimeConfiguration

@get:Internal

abstract val jetbrainsRuntimeConfiguration: ConfigurableFileCollection

Holds the Configurations.JETBRAINS_RUNTIME configuration with the JetBrains Runtime dependency added. It should not be directly accessed.

@get:Optional

@get:Input

abstract var jvmArgs: List<String?>?

jvmArgumentProviders

abstract val jvmArgumentProviders: List<CommandLineArgumentProvider?>?

@get:Optional

@get:Input

abstract var maxHeapSize: @Nullable String?

@get:Optional

@get:Input

abstract var minHeapSize: @Nullable String?

@get:Internal

abstract val module: Property<Boolean>

Indicates if the current project represents an IntelliJ Platform plugin module.

@get:Internal

open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val pluginXml: RegularFileProperty

Holds the path to the patched plugin.xml file.

@get:Internal

open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

runtimeArchitecture

@get:Internal

abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

runtimeDirectory

@get:Internal

abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

runtimeLauncher

@get:Internal

abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

runtimeMetadata

@get:Internal

abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

sandboxConfigDirectory

@get:Internal

abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxDirectory.

sandboxDirectory

@get:Internal

abstract val sandboxDirectory: DirectoryProperty

The directory containing content read and produced by the running IDE.

sandboxLogDirectory

@get:Internal

abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxDirectory.

sandboxPluginsDirectory

@get:Internal

abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxDirectory.

sandboxSystemDirectory

@get:Internal

abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxDirectory.

systemProperties

@get:Input

abstract var systemProperties: Map<String?, @Nullable Any?>?

@get:Internal

abstract val testSandbox: Property<Boolean>

Defines if the current sandbox is related to testing.

abstract var workingDir: File?

Functions

applyFrontendSandboxFrom

open fun Task.applyFrontendSandboxFrom(sandboxProducerTaskProvider: TaskProvider<PrepareSandboxTask>)

applySandboxFrom

open fun Task.applySandboxFrom(sandboxProducerTaskProvider: TaskProvider<PrepareSandboxTask>)

bootstrapClasspath

abstract fun bootstrapClasspath(vararg classpath: @Nullable Any?): JavaForkOptions?

abstract fun copyTo(options: JavaForkOptions?): JavaForkOptions?

abstract fun copyTo(options: ProcessForkOptions?): ProcessForkOptions?

abstract fun debugOptions(action: Action<JavaDebugOptions?>?)

abstract fun environment(environmentVariables: Map<String?, *>?): ProcessForkOptions?

abstract fun environment(name: String?, value: Any?): ProcessForkOptions?

abstract fun executable(executable: Any?): ProcessForkOptions?

abstract fun jvmArgs(arguments: Iterable<*>?): JavaForkOptions?

abstract fun jvmArgs(vararg arguments: Any?): JavaForkOptions?

systemProperties

abstract fun systemProperties(properties: Map<String?, out @Nullable Any?>?): JavaForkOptions?

abstract fun systemProperty(name: String?, value: @Nullable Any?): JavaForkOptions?

validateIntelliJPlatformVersion

open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

abstract fun workingDir(dir: Any?): ProcessForkOptions?