Package edu.umd.cs.findbugs

Class DetectorFactoryCollection

  • public class DetectorFactoryCollection
extends java.lang.Object
    The DetectorFactoryCollection stores all of the DetectorFactory objects used to create the Detectors which implement the various analyses. It is a singleton class.
    See Also:
    DetectorFactory

    • Field Detail

      • LOGGER

        private static final java.util.logging.Logger LOGGER

      • DEBUG_JAWS

        private static final boolean DEBUG_JAWS

      • lock

        private static final java.lang.Object lock

      • pluginByIdMap

        private final java.util.Map<java.lang.String,​Plugin> pluginByIdMap

      • corePlugin

        private Plugin corePlugin

      • factoriesByName

        private final java.util.Map<java.lang.String,​DetectorFactory> factoriesByName

      • factoriesByDetectorClassName

        private final java.util.Map<java.lang.String,​DetectorFactory> factoriesByDetectorClassName

      • categoryDescriptionMap

        protected final java.util.Map<java.lang.String,​BugCategory> categoryDescriptionMap

      • bugPatternMap

        protected final java.util.Map<java.lang.String,​BugPattern> bugPatternMap

      • bugCodeMap

        protected final java.util.Map<java.lang.String,​BugCode> bugCodeMap

      • globalOptions

        final java.util.Map<java.lang.String,​java.lang.String> globalOptions

      • globalOptionsSetter

        final java.util.Map<java.lang.String,​Plugin> globalOptionsSetter

    • Constructor Detail

      • DetectorFactoryCollection

        public DetectorFactoryCollection()

      • DetectorFactoryCollection

        public DetectorFactoryCollection​(Plugin onlyPlugin)

      • DetectorFactoryCollection

        protected DetectorFactoryCollection​(java.util.Collection<Plugin> enabled)

      • DetectorFactoryCollection

        private DetectorFactoryCollection​(boolean loadCore,
                                  boolean forceLoad,
                                  @Nonnull
                                  java.util.Collection<Plugin> pluginsToLoad,
                                  @Nonnull
                                  java.util.Collection<Plugin> enabledPlugins)

    • Method Detail

      • resetInstance

        public static void resetInstance​(@CheckForNull
                                 DetectorFactoryCollection instance)
        Reset the factory singleton.

        Implementation note: This method is public for tests only!

        Parameters:
        instance - use null to clear the instance

      • instance

        public static DetectorFactoryCollection instance()
        Get the single instance of DetectorFactoryCollection, which knows each and every loaded plugin, independently of it's enablement

      • setGlobalOptions

        private void setGlobalOptions()

      • pluginIterator

        public java.util.Iterator<Plugin> pluginIterator()
        Return an Iterator over all available Plugin objects.

      • plugins

        public java.util.Collection<Plugin> plugins()
        Return an Collection of all available Plugin objects.

      • getCorePlugin

        @Nonnull
public Plugin getCorePlugin()

      • getPluginById

        public Plugin getPluginById​(java.lang.String pluginId)
        Get a Plugin by its unique id.
        Parameters:
        pluginId - the unique id
        Returns:
        the Plugin with that id, or null if no such Plugin is found

      • factoryIterator

        public java.util.Iterator<DetectorFactory> factoryIterator()
        Return an Iterator over the DetectorFactory objects for all registered Detectors.

      • getFactories

        public java.lang.Iterable<DetectorFactory> getFactories()
        Return an Iterable over the DetectorFactory objects for all registered Detectors.

      • isDisabledByDefault

        public boolean isDisabledByDefault​(java.lang.String bugPatternOrCode)

      • getFactory

        public DetectorFactory getFactory​(java.lang.String name)
        Look up a DetectorFactory by its short name.
        Parameters:
        name - the short name
        Returns:
        the DetectorFactory, or null if there is no factory with that short name

      • getFactoryByClassName

        public DetectorFactory getFactoryByClassName​(java.lang.String className)
        Look up a DetectorFactory by its class name.
        Parameters:
        className - the class name
        Returns:
        the DetectoryFactory, or null if there is no factory with that class name

      • registerDetector

        void registerDetector​(DetectorFactory factory)
        Register a DetectorFactory.

      • inferSpotBugsHome

        private static java.lang.String inferSpotBugsHome()
        See if the location of ${spotbugs.home} can be inferred from the location of findbugs.jar in the classpath.
        Returns:
        inferred ${spotbugs.home}, or null if we can't figure it out

      • getFindBugsHome

        public static java.lang.String getFindBugsHome()

      • getCoreResource

        @CheckForNull
public static java.net.URL getCoreResource​(java.lang.String name)

      • loadCorePlugin

        private void loadCorePlugin()

      • jawsDebugMessage

        public static void jawsDebugMessage​(java.lang.String message)

      • loadPlugin

        void loadPlugin​(Plugin plugin)

      • unLoadPlugin

        void unLoadPlugin​(Plugin plugin)

      • registerBugCategory

        public boolean registerBugCategory​(BugCategory bc)
        Set the metadata for a bug category. If the category's metadata has already been set, this does nothing.
        Parameters:
        bc - the BugCategory object holding the metadata for the category
        Returns:
        false if the category's metadata has already been set, true otherwise

      • unRegisterBugCategory

        protected boolean unRegisterBugCategory​(BugCategory bc)

      • registerBugPattern

        public void registerBugPattern​(BugPattern bugPattern)
        Register a BugPattern.
        Parameters:
        bugPattern - the BugPattern

      • unRegisterBugPattern

        protected void unRegisterBugPattern​(BugPattern bugPattern)

      • bugPatternIterator

        public java.util.Iterator<BugPattern> bugPatternIterator()
        Get an Iterator over all registered bug patterns.

      • getBugPatterns

        public java.util.Collection<BugPattern> getBugPatterns()
        Get an Iterator over all registered bug patterns.

      • lookupBugPattern

        @CheckForNull
public BugPattern lookupBugPattern​(java.lang.String bugType)
        Look up bug pattern.
        Parameters:
        bugType - the bug type for the bug pattern
        Returns:
        the BugPattern, or null if it can't be found

      • registerBugCode

        public void registerBugCode​(BugCode bugCode)

      • unRegisterBugCode

        protected void unRegisterBugCode​(BugCode bugCode)

      • getBugCodes

        public java.util.Collection<BugCode> getBugCodes()

      • getBugCode

        @Nonnull
public BugCode getBugCode​(java.lang.String shortBugType)
        Get a description for given "bug type". FIXME: this is referred to elsewhere as the "bug code" or "bug abbrev". Should make the terminology consistent everywhere. In this case, the bug type refers to the short prefix code prepended to the long and short bug messages.
        Parameters:
        shortBugType - the short bug type code
        Returns:
        the description of that short bug type code means

      • lookupBugCode

        @CheckForNull
public BugCode lookupBugCode​(java.lang.String shortBugType)
        Parameters:
        shortBugType - the short bug type code
        Returns:
        the description of that short bug type code means

      • getBugCategory

        public BugCategory getBugCategory​(java.lang.String category)
        Get the BugCategory object for a category key. Returns null if no BugCategory object can be found.
        Parameters:
        category - the category key
        Returns:
        the BugCategory object (may be null)

      • getBugCategories

        public java.util.Collection<java.lang.String> getBugCategories()
        Get a Collection containing all known bug category keys. E.g., "CORRECTNESS", "MT_CORRECTNESS", "PERFORMANCE", etc. Excludes hidden bug categories
        Returns:
        Collection of bug category keys.

      • getBugCategoryObjects

        public java.util.Collection<BugCategory> getBugCategoryObjects()