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

FileContainerItem

open class FileContainerItem : AItem, IItem, IOSSpecific, IContainer

Provides a zip package definition for the component extension.

Parameters

project - provides the current Gradle project.

name - package name for identification. It is also used for the installed path of the package

Constructors

<init>

FileContainerItem(project: Project, name: String)

provides a preconfigured package with a name

Properties

baseName

var baseName: String

This property is used for the creation of the container artifact. The default value is the project name.

classifier

open var classifier: String

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

excludes

open val excludes: Set<String>

Files that matches to one of the patterns will be excluded from the update installation.

itemType

open var itemType: String

The package type describes the usage of this special package. The default value is the package name.

name

val name: String

package name for identification. It is also used for the installed path of the package

preserve

val preserve: PatternFilterable

Get patternset to preserve files from update. Files that matches to one of patterns will be excluded/included from the update installation.

preserveExcludes

open val preserveExcludes: Set<String>

This patterns are used for the update. Files that matches to one of patterns will be excluded in the preserve set of the update installation.

preserveIncludes

open val preserveIncludes: Set<String>

This patterns are used for the update. Files that matches to one of patterns will be included in the preserve set of the update installation.

source

var source: FileCollection

All files that will be packaged to a zip file for this special package item.

targetIncluded

open var targetIncluded: Boolean

Is the target path included in the component? This is an important information for the deployment of the component. Default value is false - target is not included in the module.

targetPath

open var targetPath: String

The default target path of the component. This is sub path in the component. Default value is an empty string.

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

exclude

fun exclude(pattern: String): Boolean

Adds a pattern to the set of exclude patterns. Files that matches to one of patterns will be excluded from the update installation. If the pattern is part of the list, the method returns false.

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

Adds a set of patterns to the set of exclude patterns. Files that matches to one of patterns will be excluded from the update installation. If one of the patterns is part of the list, the method returns false.

preserve

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

Configure preserve pattern set, to preserve files during the update installation of this module.

source

fun source(vararg paths: Any): Unit

Add source files to the package definition.

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.