component-build-plugin / com.intershop.gradle.component.build.extension.items / LinkItem

LinkItem

class LinkItem : AItem, IItem

This class represents a link configuration of a component.

Constructors

<init>

LinkItem(name: String, targetPath: String)

initializes a configuration from target name and target path.

Properties

classifiers

var classifiers: Set<String>

This set contains OS specific descriptions. The set is empty per default. It is defined as an task input property.

name

val name: String

the name of the link

targetPath

val targetPath: String

the target path of the link

updatable

var updatable: Boolean

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

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.

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.