Enum Class ExtensionModule

java.lang.Object
java.lang.Enum<ExtensionModule>
de.hybris.bootstrap.config.ExtensionModule
All Implemented Interfaces:
Serializable, Comparable<ExtensionModule>, Constable

public enum ExtensionModule extends Enum<ExtensionModule>
Type of known extension module. The following extension modules are known:
Standard
Normal extension. Sources are directly in the root folder of the extension.
Web Module
Web related. Sources are in the subfolder web.
hMC module
Web related. Sources are in the subfolder hmc.
HAC module
Web related. Sources are in the subfolder hac.
An extension may contain more than one module type.

Module types which are web related imply that web classes are required on the classpath.

  • Enum Constant Details

    • STANDARD

      public static final ExtensionModule STANDARD
      Standard tests in the folder /testsrc. Available in all extensions.
    • WEB

      public static final ExtensionModule WEB
      Web tests in the folder /web/testsrc. May require the backoffice extension on the classpath.
    • HMC

      public static final ExtensionModule HMC
      hMC tests in the folder /hmc/testsrc. Always require the hmc extension on the classpath.
    • HAC

      public static final ExtensionModule HAC
      HAC tests in the folder /hac/testsrc. Always require the hac extension on the classpath.
  • Method Details

    • values

      public static ExtensionModule[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ExtensionModule valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • webModuleExists

      protected static boolean webModuleExists(ExtensionInfo extensionInfo)
      This function checks if a web module exists in the given extension.
    • containsBackofficeTests

      protected static boolean containsBackofficeTests(ExtensionInfo extensionInfo)
      Check if an extension contains backoffice tests.
      Parameters:
      extensionInfo - The extension to check.
      Returns:
      true if backoffice tests exist in the given extension.
    • hacModuleExists

      protected static boolean hacModuleExists(ExtensionInfo extensionInfo)
      This function checks if a HAC module exists in the given extension, i.e. if the given extension is a HAC extension.
    • shouldBeLoadedForWebtests

      protected static boolean shouldBeLoadedForWebtests(ExtensionInfo extensionInfo)
      This function checks if libraries from web module should be added to the test classpath.
    • values

      public static ExtensionModule[] values(boolean webRelated)
      Get all known extension module types which either are or are not web related.
      Parameters:
      webRelated - true to get only web related module types, false to get only module types which are not web related.
      Returns:
      List of selected module types.
    • exists

      public boolean exists(ExtensionInfo extensionInfo)
      Check if a module of this extension module type exists in the given extension.
    • getBasePath

      public File getBasePath(ExtensionInfo extensionInfo)
      Get the path where the sources of a module of this type are located in the given extension.
    • getTestClassFileName

      public String getTestClassFileName()
      Get the file name of the XML file where the scanned test classes for modules of this type are stored.
    • requiresBackoffice

      public boolean requiresBackoffice()
      Check if modules of this type may require the backoffice extension.
    • getRequiredWebExtensions

      public Collection<String> getRequiredWebExtensions()
      Return web related extensions required on the classpath by this extension module type.
    • isWebRelated

      public boolean isWebRelated()
      Check if modules of this type are web related and require web libraries on their classpath.