component-build-plugin / com.intershop.gradle.component.build.tasks / CreateComponentTask

CreateComponentTask

open class CreateComponentTask : DefaultTask

CreateComponentTask Gradle task 'createComponent'

The injected dependencyHandler is used for internal dependency handling. This task hast currently no declared inputs and outputs and builds file not incremental.

Constructors

<init>

CreateComponentTask()

CreateComponentTask Gradle task 'createComponent'

Properties

componentDescription

var componentDescription: String

This property contains the description of the component. Declares a task input for incremental build.

containers

var containers: FileContainerItemContainer?

This is the container for all zip container of this component.

defaultTarget

var defaultTarget: String

This property contains the the default target path for the installation.

dependencyExcludes

var dependencyExcludes: Set<DependencyConfig>

This is a set with all eexclude patterns for all dependencies.

descriptorFile

var descriptorFile: File

The output file contains the descriptor of the component.

descriptorPath

var descriptorPath: String

This is the path for the descriptor file of an installed component.

directories

var directories: DirectoryContainer?

This is the container for all zip container of this component.

displayName

var displayName: String

This property contains the display name of the component. Declares a task input for incremental build.

files

var files: FileItemContainer?

This is the container for all single files of this component.

libs

var libs: LibraryItemContainer?

Container for all libs. This contains dependencies that must be resolved. Depending on the final version of this dependency, the descriptor must be new generated. Therefore this input is marked as internal and the task is not incremental.

links

var links: LinkItemContainer?

This is the container for all zip container of this component.

modules

var modules: ModuleItemContainer?

Container for all modules. This contains dependencies that must be resolved. Depending on the final version of this dependency, the descriptor must be new generated. Therefore this input is marked as internal and the task is not incremental.

preserveExcludes

val preserveExcludes: Set<String>

This patterns are used for the update. Files that matches to one of patterns will be excluded from the preserved files.

preserveIncludes

val preserveIncludes: Set<String>

This patterns are used for the update. Files that matches to one of patterns will be included from the preserved files.

properties

var properties: PropertyItemContainer?

This is the container for all properties of this component.

recreate

var recreate: Boolean

Projects will be handled incremental without considering build configuration of the project. the parameter '--recreate' will enable an automatic recreation if project dependencies are available.

resolvedLibs

val resolvedLibs: Set<DependencyConfig>

Resolved libraries from list of items. (read only).

resolvedModules

val resolvedModules: Set<DependencyConfig>

Resolved modules from list of items. (read only).

updateExcludes

val updateExcludes: Set<String>

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

Functions

createDescriptor

fun createDescriptor(): Unit

Task method for the creation of a descriptor file. This is one of the artifacts of a component.

preserve

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

Add pattern to the set of patterns. Files that matches to one of patterns will be excluded or included to the update installation.

provideComponentDescription

fun provideComponentDescription(description: Provider<String>): Unit

Set provider for component description property.

provideDefaultTarget

fun provideDefaultTarget(defaultTarget: Provider<String>): Unit

Set provider for default target property.

provideDescriptorFile

fun provideDescriptorFile(descriptorFile: Provider<RegularFile>): Unit

Set provider for descriptor file property.

provideDisplayName

fun provideDisplayName(displayName: Provider<String>): Unit

Set provider for display name property.

providePreserve

fun providePreserve(patternSet: PatternFilterable): Unit

Configure pattern set to update preserve pattern set.

provideUpdateExcludes

fun provideUpdateExcludes(pattern: Provider<Set<String>>): Unit

Set provider for default property of exclude pattern set from update.

updateExclude

fun updateExclude(pattern: String): Unit

Adds a pattern to the set of exclude patterns. Files that matches to one of patterns will be excluded from the update installation.

fun updateExclude(patterns: Set<String>): Unit

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.