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

FileItem

class FileItem : AItem, IItem, IOSSpecific

This class provides a file object configuration of the component.

Constructors

<init>

FileItem(file: File)

provides a configured file item

Properties

classifier

var classifier: String

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

extension

var extension: String

The file extension of the item. This is marked as task input.

file

val file: File

the real file item of the component. This is marked as task input.

name

var name: String

The file name of the item. This is marked as task input.

targetPath

var targetPath: String

The target path of this file. This is marked as task input.

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.