class ModuleItem : ADependencyItem, IItem, IContainer, IDependency
This class provides a module object for the component extension of the component build plugin.
ModuleItem(project: Project, dependency: DependencyConfig)
initialize an module with a defined dependency |
val dependency: DependencyConfig
a dependency configuration of this module |
|
var descriptorPath: String
The target path for descriptor files of this module. |
|
val excludes: Set<String>
Files that matches to one of patterns will be excluded from the update installation. |
|
var itemType: String
This property can be used to add a special type description for a module. |
|
var jarPath: String
The target path for all jar files of this module. |
|
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. |
|
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. |
|
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. |
|
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. |
|
var targetPath: String
The default target path of the component. This is sub path in the component. Default value is an empty string. |
|
var updatable: Boolean
If an item should not be part of an update installation, this property is set to false. |
open var resolveTransitive: Boolean
This property configures the dependency resolution of the configured dependency during the creation of the descriptor. The descriptor must be complete! The default value is true. |
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. |
|
fun preserve(action: Action<in PatternFilterable>): Unitfun preserve(closure: Closure<Any>): Unit
Configure preserve pattern set, to preserve files during the update installation of this module. |