com.intershop.gradle.icm.tasks

Class ExtendCartridgeList

com.intershop.gradle.icm.tasks.ExtendCartridgeList

public class ExtendCartridgeList

Task for the extension of an existing properties template with project configuration settings.

Field Detail

CARTRIDGELISTFILE_NAME

@NotNull
public static java.lang.String CARTRIDGELISTFILE_NAME

Path for original cartridge list properties in build directory.

See Also:

Constant Field Values

CARTRIDGES_PROPERTY

@NotNull
public static java.lang.String CARTRIDGES_PROPERTY

Property name for cartridges.

See Also:

Constant Field Values

CARTRIDGES_DBINIT_PROPERTY

@NotNull
public static java.lang.String CARTRIDGES_DBINIT_PROPERTY

Property name for dbinit/dbprepare cartridges.

See Also:

Constant Field Values

Companion

public static com.intershop.gradle.icm.tasks.ExtendCartridgeList.Companion Companion

Constructor Detail

ExtendCartridgeList

@Inject
public ExtendCartridgeList(@NotNull
                                   org.gradle.api.file.ProjectLayout projectLayout,
                                   @NotNull
                                   org.gradle.api.model.ObjectFactory objectFactory)

Creates a task for editing a special configuration file.

Method Detail

getCartridges

@Input
 @NotNull
public org.gradle.api.provider.SetProperty<java.lang.String> getCartridges()

provideCartridges

public void provideCartridges(@NotNull
                              org.gradle.api.provider.Provider<java.util.Set> list)

Provides a list of all additional project cartridges (project names, dependencies) for the ICM project.

Parameters:

list - provider of a String set.

getDbprepareCartridges

@Input
 @NotNull
public org.gradle.api.provider.SetProperty<java.lang.String> getDbprepareCartridges()

provideDBprepareCartridges

public void provideDBprepareCartridges(@NotNull
                                       org.gradle.api.provider.Provider<java.util.Set> list)

Provides a list of all additional DB project cartridges (project names, dependencies) for the ICM project.

Parameters:

list - provider of a String set.

getTemplateFile

@InputFile
 @NotNull
public org.gradle.api.file.RegularFileProperty getTemplateFile()

provideTemplateFile

public void provideTemplateFile(@NotNull
                                org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> file)

Provides the base template file "cartridgelist.properties" from a base project.

Parameters:

file - provider of a regular file.

getEnvironmentTypes

@Optional
 @Input
 @NotNull
public org.gradle.api.provider.ListProperty<com.intershop.gradle.icm.utils.EnvironmentType> getEnvironmentTypes()

provideEnvironmentTypes

public void provideEnvironmentTypes(@NotNull
                                    org.gradle.api.provider.Provider<java.util.List> list)

Provides a list of environment types which should be handeled by this created list configuration.

Parameters:

list - provider of a list of environment types.

getOutputFile

@OutputFile
 @NotNull
public org.gradle.api.file.RegularFileProperty getOutputFile()

provideOutputFile

public void provideOutputFile(@NotNull
                              org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> file)

Provides the output file of this task. It contains the cartridge list configuration of this project for special environment types.

Parameters:

file - regular file provider.

extendList

public void extendList()

Task execution method of this task. It creates the new property file.