org.broadleafcommerce.common.module

Class ModulePresentUtil

java.lang.Object

org.broadleafcommerce.common.module.ModulePresentUtil

public class ModulePresentUtil
extends Object

Utility class that checks for the presence of registered Broadleaf modules.

Author:

Nathan Moore (nathanmoore)., Phillip Verheyden (phillipuniverse), Philip Baggett (pbaggett)

See Also:

ConditionalOnBroadleafModule}, OnBroadleafModuleCondition}

Field Summary

Fields

Modifier and Type	Field and Description
static List<BroadleafModuleRegistration>	MODULE_REGISTRATIONS

Constructor Summary

Constructors

Constructor and Description
ModulePresentUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	allPresent(List<String> modulesInQuestion) Checks that every module in the list is registered.
static boolean	isPresent(BroadleafModuleRegistration.BroadleafModuleEnum moduleInQuestion) Checks if the given module is registered
static boolean	isPresent(String moduleInQuestion) This version takes a String instead of a BroadleafModuleRegistration.BroadleafModuleEnum but operates in the same way by checking to see if a particular Broadleaf module has registered itself

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE_REGISTRATIONS

public static final List<BroadleafModuleRegistration> MODULE_REGISTRATIONS

Constructor Detail

ModulePresentUtil

public ModulePresentUtil()

Method Detail

isPresent

public static boolean isPresent(@Nonnull
                                BroadleafModuleRegistration.BroadleafModuleEnum moduleInQuestion)

Checks if the given module is registered

Parameters:

moduleInQuestion - the module that should be checked

Returns:

whether the module in question has registered itself at runtime

See Also:

#isPresent(String)}

allPresent

public static boolean allPresent(@Nonnull
                                 List<String> modulesInQuestion)

Checks that every module in the list is registered.

Parameters:

modulesInQuestion - list of modules that should be checked

Returns:

true if all modules in the list are present, false otherwise

See Also:

isPresent(String)

isPresent

public static boolean isPresent(@Nonnull
                                String moduleInQuestion)

This version takes a String instead of a BroadleafModuleRegistration.BroadleafModuleEnum but operates in the same way by checking to see if a particular Broadleaf module has registered itself

Parameters:

moduleInQuestion - a String that maps to ModuleLifecycleLoggingBean.getModuleName()