component-build-plugin / com.intershop.gradle.component.build.extension.container / LinkItemContainer

LinkItemContainer

open class LinkItemContainer : AItem

This class provides a container for deployable link configurations.

Constructors

<init>

LinkItemContainer(parent: ComponentExtension)

provides an empty preconfigured link item container

Properties

items

val items: Set<LinkItem>

This set provides all configured links.

parent

val parent: ComponentExtension

the parent of this container.

updatable

var updatable: Boolean

If an item should not be part of an update installation, this property is set to true.

Inherited Properties

contentType

open var contentType: String

This property contains the content type of the item. The following values are allowed:

types

open val types: Set<String>

This set contains deployment or environment type definitions, like 'production', 'test' etc. The set can be extended. The set is empty per default. It is defined as an task input property.

Functions

add

fun add(name: String, targetPath: String, vararg types: String): LinkItem

Add a single link to the component. This links will be created during the installation.

fun add(name: String, targetPath: String): LinkItem

Add a link configuration to the configuration.

fun add(name: String, targetPath: String, action: Action<in LinkItem>): Unit

Add a link configuration to the configuration and configures this.

Inherited Functions

addType

fun addType(type: String): Boolean

Adds a new deployment or environment type. The characters will be changed to lower cases.

addTypes

fun addTypes(types: Collection<String>): Boolean

Adds a list of new deployment or environment types. The characters will be changed to lower cases.

setTypes

fun setTypes(types: Collection<String>): Unit

Reset the set with new values from input.