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.- Author:
- Oliver Burn
-
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Configuration
loadConfiguration(InputStream configStream, PropertyResolver overridePropsResolver, boolean omitIgnoredModules)
Deprecated.As this method does not provide a valid system ID, preventing resolution of external entities, aversion using an InputSource
should be used insteadstatic Configuration
loadConfiguration(String config, PropertyResolver overridePropsResolver)
Returns the module configurations in a specified file.static Configuration
loadConfiguration(String config, PropertyResolver overridePropsResolver, boolean omitIgnoredModules)
Returns the module configurations in a specified file.static Configuration
loadConfiguration(InputSource configSource, PropertyResolver overridePropsResolver, boolean omitIgnoredModules)
Returns the module configurations from a specified input source.
-
-
-
Method Detail
-
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 filenameoverridePropsResolver
- overriding properties- Returns:
- the check configurations
- Throws:
CheckstyleException
- if an error occurs
-
loadConfiguration
public static Configuration loadConfiguration(String config, PropertyResolver overridePropsResolver, boolean omitIgnoredModules) throws CheckstyleException
Returns the module configurations in a specified file.- Parameters:
config
- location of config file, can be either a URL or a filenameoverridePropsResolver
- overriding propertiesomitIgnoredModules
-true
if modules with severity 'ignore' should be omitted,false
otherwise- Returns:
- the check configurations
- Throws:
CheckstyleException
- if an error occurs
-
loadConfiguration
@Deprecated public static Configuration loadConfiguration(InputStream configStream, PropertyResolver overridePropsResolver, boolean omitIgnoredModules) throws CheckstyleException
Deprecated.As this method does not provide a valid system ID, preventing resolution of external entities, aversion using an InputSource
should be used insteadReturns the module configurations from a specified input stream. Note that clients are required to close the given stream by themselves- Parameters:
configStream
- the input stream to the Checkstyle configurationoverridePropsResolver
- overriding propertiesomitIgnoredModules
-true
if modules with severity 'ignore' should be omitted,false
otherwise- Returns:
- the check configurations
- Throws:
CheckstyleException
- if an error occurs
-
loadConfiguration
public static Configuration loadConfiguration(InputSource configSource, PropertyResolver overridePropsResolver, boolean omitIgnoredModules) 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 configurationoverridePropsResolver
- overriding propertiesomitIgnoredModules
-true
if modules with severity 'ignore' should be omitted,false
otherwise- Returns:
- the check configurations
- Throws:
CheckstyleException
- if an error occurs
-
-