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

ModuleItemContainer

open class ModuleItemContainer : AContainer

This class provides all properties for the module container extension.

Constructors

<init>

ModuleItemContainer(dependencyHandler: DependencyHandler, project: Project, parent: ComponentExtension)

provides an empty preconfigured module container

Properties

descriptorPath

var descriptorPath: String

The target path for descriptor files of each module. This value is used to preconfigure a module item.

items

val items: Set<ModuleItem>

This set provides all configured modules. This list will be completed by the transitive dependencies of the component.

jarPath

var jarPath: String

The target path for jar files of each module. This value is used to preconfigure a module item.

parent

open val parent: ComponentExtension

the parent of this container.

project

val project: Project

resolveTransitive

var resolveTransitive: Boolean

This property configures the dependency resolution of the configured dependencies during the creation of the descriptor. The descriptor must be complete! The default value is true.

updatable

var updatable: Boolean

If an item should not be part of an update installation, this property is set to false.

Inherited Properties

defTargetPath

val defTargetPath: String

description

val description: String

a short description of this container for log messages.

targetPath

var targetPath: String

This path describes the installation in the default installation of the component.

Functions

add

fun add(dependency: Any, vararg types: String): ModuleItem

Add a dependency of a module from any possible definition with special type configuration to the library list. This dependency will be resolved transitive!

fun add(dependency: Any): ModuleItem
fun add(dependency: Any, action: Action<in ModuleItem>): Unit

Add a dependency from any possible definition a to the configuration.

fun add(libs: Collection<Any>): Unit

Add a list of dependencies to the library list.

Inherited Functions

addTypes

fun addTypes(item: AItem): Unit

Add types to types list from item.