component-installation-plugin / com.intershop.gradle.component.installation.extension / InstallationExtension

InstallationExtension

open class InstallationExtension

The main extension of this plugin.

It provides all information for the installation process with all components and directories.

Constructors

<init>

InstallationExtension(project: Project)

initialize the extension for the current project.

Properties

components

val components: Set<Component>

Set of components that will be installed in the project.

environment

var environment: Set<String>

Environment configuration of the installation. This set of strings will be compared with the configuration of component items.

environmentProvider

val environmentProvider: Provider<Set<String>>

Provider for the environment configuration of the installation process.

filters

val filters: FilterContainer

This is the filter configuration container. It contains all file filter to adapt an installation.

installConfig

val installConfig: InstallConfiguration

The container for installation configuration.

installDir

var installDir: File

Installation directory for all components. This is the root directory for all configured components.

installDirProvider

val installDirProvider: Provider<Directory>

Provider for the installation directory property.

project

val project: Project

instance of the current project.

Functions

add

fun add(component: Any): Component

Adds a dependency to the list of components.

fun add(component: Any, path: String): Component

Adds a dependency to the list of components and configures the path of the component.

fun add(component: Any, action: Action<in Component>): Component

Adds a dependency to the list of components. The component is configured with an action or closure.

fun add(component: Any, path: String, action: Action<in Component>): Component

Adds a dependency to the list of components and configures the path of the component. The component is configured with an action or closure.

environment

fun environment(config: String): Unit

Add an environment configuration to the set of configuration strings.

filters

fun filters(action: Action<in FilterContainer>): Unit

This method configures the filter container.

installConfig

fun installConfig(action: Action<in InstallConfiguration>): Unit

Configures the installation configuration container.

Companion Object Properties

INSTALLATION_EXTENSION_NAME

const val INSTALLATION_EXTENSION_NAME: String

The name of the installation extension.