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

Component

data class Component

This is the configuration container of a components. It is initialized with the dependency and the installation path. If the path is not specified the information is taken from the descriptor.

Constructors

<init>

Component(group: String, module: String, version: String, path: String = "")

initialize a simple component without any additional configuration.

Properties

commonName

val commonName: String

This is the common name of the component within the installation project.

dependency

val dependency: Dependency

The dependency object of the component. This is used for further installation steps.

excludes

val excludes: Set<String>

Exclude patterns will be used to exclude special files from the installation or update. Please note, that excluded files will be also removed from an existing installation.

fileItems

val fileItems: LocalFileContainer

The container of local file items, that can be installed.

group

val group: String

the group or organization of the component dependency.

module

val module: String

the module or name of the of the component dependency.

path

val path: String

the path of the component in the configured installation dir.

preserve

val preserve: PatternFilterable

Preserve patterns will used be excluded or included files. Installed files will preserved.

version

val version: String

the version or revision of the component dependency.

Functions

exclude

fun exclude(pattern: String): Unit

Add a pattern to the exclude pattern set.

fun exclude(patterns: Set<String>): Unit

Add a set of patterns to the exclude pattern set.

fileItems

fun fileItems(closure: Closure<Any>): Unit
fun fileItems(action: Action<in LocalFileContainer>): Unit

Configures the container of local files.

preserve

fun preserve(closure: Closure<Any>): Unit
fun preserve(action: Action<in PatternFilterable>): Unit

Configures the preserve pattern set.