Package com.intershop.gradle.icm.utils

Object CartridgeUtil

  • All Implemented Interfaces:
    
public class CartridgeUtil

    Object class for handling of remote cartridge artifacts.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • getFileIDFrom

         final String getFileIDFrom(ModuleComponentIdentifier identifier)

        Calculates id / base file name from module dependency pf a file.

        Parameters:
        identifier - module identifier of the dependency

      • isCartridge

         final Boolean isCartridge(Project project, ModuleComponentIdentifier identifier)

        Returns true, if dependency is an external cartridge.

        Parameters:
        project - the root project
        identifier - module identifier of the dependency

      • isCartridge

         final Boolean isCartridge(DependencyHandler dependencyHandler, Logger logger, ModuleComponentIdentifier identifier)

        Returns true, if dependency is an external cartridge. Use this overload at task execution time to avoid accessing task.project.

        Parameters:
        dependencyHandler - the dependency handler
        logger - a logger instance
        identifier - module identifier of the dependency

      • isCartridge

         final Boolean isCartridge(Project project, ExternalModuleDependency dependency, List<EnvironmentType> environmentTypes)

        Returns true, if dependency is an external cartridge and the style is a production like cartridge. This is only checked if style is specified

        Parameters:
        project - the root project
        dependency - cartridge dependency
        environmentTypes - list of environment types

      • isCartridge

         final Boolean isCartridge(Project project, String group, String module, String version, List<EnvironmentType> environmentTypes)

        Returns true, if dependency is an external cartridge and the style is a production like cartridge. This is only checked if style is specified

        Parameters:
        project - the root project
        group - module group of the external cartridge
        module - module name of the external cartridge
        version - version of the external cartridge
        environmentTypes - list of environment types

      • isCartridge

         final Boolean isCartridge(DependencyHandler dependencyHandler, Logger logger, String group, String module, String version, List<EnvironmentType> environmentTypes)

        Returns true, if dependency is an external cartridge and the style is a production like cartridge. This is only checked if style is specified. Use this overload at task execution time to avoid accessing task.project.

        Parameters:
        dependencyHandler - the dependency handler
        logger - a logger instance
        group - module group of the external cartridge
        module - module name of the external cartridge
        version - version of the external cartridge
        environmentTypes - list of environment types

      • getDepenendencySet

        @Deprecated(message = "Will be removed in next major", replaceWith = @ReplaceWith(expression = "getDependencySet(project, moduledep)"), level = DeprecationLevel.WARNING) final Set<String> getDepenendencySet(Project project, String moduledep)

        Returns a set of dependencies from a BOM file.

        Parameters:
        project - the root project
        moduledep - external module dependency - short notation

      • getDepenendencySet

        @Deprecated(message = "Will be removed in next major", replaceWith = @ReplaceWith(expression = "getDependencySet(project, group, module, version)"), level = DeprecationLevel.WARNING) final Set<String> getDepenendencySet(Project project, String group, String module, String version)

        Returns a set of dependencies from a BOM file.

        Parameters:
        project - the root project
        group - module group of the BOM
        module - module name of the BOM
        version - version of the BOM

      • getDependencySet

         final Set<String> getDependencySet(Project project, String moduleDependency)

        Returns a set of dependencies from a BOM file.

        Parameters:
        project - the root project
        moduleDependency - external module dependency - short notation

      • getDependencySet

         final Set<String> getDependencySet(Project project, String group, String module, String version)

        Returns a set of dependencies from a BOM file.

        Parameters:
        project - the root project
        group - module group of the BOM
        module - module name of the BOM
        version - version of the BOM

      • getDependencySet

         final Set<String> getDependencySet(DependencyHandler dependencyHandler, Logger logger, String group, String module, String version)

        Returns a set of dependencies from a BOM file. Use this overload at task execution time to avoid accessing task.project.

        Parameters:
        dependencyHandler - the dependency handler
        logger - a logger instance
        group - module group of the BOM
        module - module name of the BOM
        version - version of the BOM