Package de.hybris.bootstrap.config
Enum Class ExtensionModule
- All Implemented Interfaces:
Serializable,Comparable<ExtensionModule>,Constable
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.
Module types which are web related imply that web classes are required on the classpath.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionprotected static booleancontainsBackofficeTests(ExtensionInfo extensionInfo) Check if an extension contains backoffice tests.booleanexists(ExtensionInfo extensionInfo) Check if a module of this extension module type exists in the given extension.getBasePath(ExtensionInfo extensionInfo) Get the path where the sources of a module of this type are located in the given extension.Return web related extensions required on the classpath by this extension module type.Get the file name of the XML file where the scanned test classes for modules of this type are stored.protected static booleanhacModuleExists(ExtensionInfo extensionInfo) This function checks if a HAC module exists in the given extension, i.e.booleanCheck if modules of this type are web related and require web libraries on their classpath.booleanCheck if modules of this type may require thebackofficeextension.protected static booleanshouldBeLoadedForWebtests(ExtensionInfo extensionInfo) This function checks if libraries from web module should be added to the test classpath.static ExtensionModuleReturns the enum constant of this class with the specified name.static ExtensionModule[]values()Returns an array containing the constants of this enum class, in the order they are declared.static ExtensionModule[]values(boolean webRelated) Get all known extension module types which either are or are not web related.protected static booleanwebModuleExists(ExtensionInfo extensionInfo) This function checks if a web module exists in the given extension.
-
Enum Constant Details
-
STANDARD
Standard tests in the folder/testsrc. Available in all extensions. -
WEB
Web tests in the folder/web/testsrc. May require thebackofficeextension on the classpath. -
HMC
hMC tests in the folder/hmc/testsrc. Always require thehmcextension on the classpath. -
HAC
HAC tests in the folder/hac/testsrc. Always require thehacextension on the classpath.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
webModuleExists
This function checks if a web module exists in the given extension. -
containsBackofficeTests
Check if an extension contains backoffice tests.- Parameters:
extensionInfo- The extension to check.- Returns:
trueif backoffice tests exist in the given extension.
-
hacModuleExists
This function checks if a HAC module exists in the given extension, i.e. if the given extension is a HAC extension. -
shouldBeLoadedForWebtests
This function checks if libraries from web module should be added to the test classpath. -
values
Get all known extension module types which either are or are not web related.- Parameters:
webRelated-trueto get only web related module types,falseto get only module types which are not web related.- Returns:
- List of selected module types.
-
exists
Check if a module of this extension module type exists in the given extension. -
getBasePath
Get the path where the sources of a module of this type are located in the given extension. -
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 thebackofficeextension. -
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.
-