Package com.puppycrawl.tools.checkstyle

Class ConfigurationLoader

java.lang.Object
com.puppycrawl.tools.checkstyle.ConfigurationLoader
public final class ConfigurationLoader extends Object
Loads a configuration from a standard configuration XML file.

  • Method Details

    • loadConfiguration

      public static Configuration loadConfiguration(String config, PropertyResolver overridePropsResolver) throws CheckstyleException
      Returns the module configurations in a specified file.
      Parameters:
      config - location of config file, can be either a URL or a filename
      overridePropsResolver - overriding properties
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs

    • loadConfiguration

      public static Configuration loadConfiguration(String config, PropertyResolver overridePropsResolver, ThreadModeSettings threadModeSettings) throws CheckstyleException
      Returns the module configurations in a specified file.
      Parameters:
      config - location of config file, can be either a URL or a filename
      overridePropsResolver - overriding properties
      threadModeSettings - the thread mode configuration
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs

    • loadConfiguration

      public static Configuration loadConfiguration(String config, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions) throws CheckstyleException
      Returns the module configurations in a specified file.
      Parameters:
      config - location of config file, can be either a URL or a filename
      overridePropsResolver - overriding properties
      ignoredModulesOptions - OMIT if modules with severity 'ignore' should be omitted, EXECUTE otherwise
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs

    • loadConfiguration

      public static Configuration loadConfiguration(String config, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions, ThreadModeSettings threadModeSettings) throws CheckstyleException
      Returns the module configurations in a specified file.
      Parameters:
      config - location of config file, can be either a URL or a filename
      overridePropsResolver - overriding properties
      ignoredModulesOptions - OMIT if modules with severity 'ignore' should be omitted, EXECUTE otherwise
      threadModeSettings - the thread mode configuration
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs

    • loadConfiguration

      public static Configuration loadConfiguration(InputSource configSource, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions) throws CheckstyleException
      Returns the module configurations from a specified input source. Note that if the source does wrap an open byte or character stream, clients are required to close that stream by themselves
      Parameters:
      configSource - the input stream to the Checkstyle configuration
      overridePropsResolver - overriding properties
      ignoredModulesOptions - OMIT if modules with severity 'ignore' should be omitted, EXECUTE otherwise
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs

    • loadConfiguration

      public static Configuration loadConfiguration(InputSource configSource, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions, ThreadModeSettings threadModeSettings) throws CheckstyleException
      Returns the module configurations from a specified input source. Note that if the source does wrap an open byte or character stream, clients are required to close that stream by themselves
      Parameters:
      configSource - the input stream to the Checkstyle configuration
      overridePropsResolver - overriding properties
      ignoredModulesOptions - OMIT if modules with severity 'ignore' should be omitted, EXECUTE otherwise
      threadModeSettings - the thread mode configuration
      Returns:
      the check configurations
      Throws:
      CheckstyleException - if an error occurs