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

PropertyItemContainer

open class PropertyItemContainer : AItem

This class provides a container for properties, that will be transferred for an deployment.

Constructors

<init>

PropertyItemContainer(parent: ComponentExtension)

provides the property container

Properties

items

val items: Set<PropertyItem>

This set provides all configured properties.

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.

Functions

add

fun add(key: String, value: String, pattern: String, vararg types: String): PropertyItem

Add property key value pair to this component definition for specified deployment types.

fun add(key: String, value: String, pattern: String): PropertyItem

Add property key value pair to this component definition.

fun add(key: String, action: Action<in PropertyItem>): Unit

Add a property with a special key and configures this item.

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.