TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added configuration loading from URLs, RFE #682140

This commit is contained in:
Lars Kühne 2003-02-08 17:57:42 +00:00
parent 410111f1dc
commit e853ed726f
2 changed files with 62 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/checkstyle/com/puppycrawl/tools/checkstyle/CheckStyleTask.java
View File

@ -29,6 +29,7 @@ import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.Hashtable;
import java.net.URL;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import org.apache.tools.ant.AntClassLoader;
@ -61,7 +62,7 @@ public class CheckStyleTask
private String mFileName;
/** config file containing configuration */
private File mConfigFile;
private String mConfigLocation;
/** contains package names */
private File mPackageNamesFile = null;
@ -159,7 +160,27 @@ public class CheckStyleTask
/** @param aFile the configuration file to use */
public void setConfig(File aFile)
{
mConfigFile = aFile;
setConfigLocation(aFile.getAbsolutePath());
}
/** @param aURL the URL of the configuration to use */
public void setConfigURL(URL aURL)
{
setConfigLocation(aURL.toExternalForm());
}
/**
* Sets the location of the configuration.
* @param aLocation the location, which is either a
*/
private void setConfigLocation(String aLocation)
{
if (mConfigLocation != null) {
throw new BuildException(
"Attributes 'config' and 'configURL' "
+ "must not be set at the same time");
}
mConfigLocation = aLocation;
}
/** @param aFile the package names file to use */
@ -201,7 +222,7 @@ public class CheckStyleTask
getLocation());
}
if (mConfigFile == null) {
if (mConfigLocation == null) {
throw new BuildException("Must specify 'config'.", getLocation());
}
@ -212,7 +233,7 @@ public class CheckStyleTask
final Properties props = createOverridingProperties();
final Configuration config =
ConfigurationLoader.loadConfiguration(
mConfigFile.getAbsolutePath(), props);
mConfigLocation, props);
DefaultContext context = new DefaultContext();
ClassLoader loader =
@ -529,4 +550,5 @@ public class CheckStyleTask
setValue(aValue.getAbsolutePath());
}
}
}

57
src/checkstyle/com/puppycrawl/tools/checkstyle/ConfigurationLoader.java
View File

@ -18,16 +18,18 @@
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.io.BufferedReader;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Stack;
import java.util.Properties;
import java.util.Stack;
import java.net.MalformedURLException;
import java.net.URL;
import javax.xml.parsers.ParserConfigurationException;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
@ -78,20 +80,21 @@ class ConfigurationLoader
}
/**
* Parses the specified file loading the configuration information.
* @param aFilename the file to parse
* @throws FileNotFoundException if an error occurs
* Parses the specified stream loading the configuration information.
* The stream is NOT closed after parsing, it is the responsibility of
* the caller to close the stream.
*
* @param aStream the stream that contains the configuration data
* @throws IOException if an error occurs
* @throws SAXException if an error occurs
*/
void parseFile(String aFilename)
throws FileNotFoundException, IOException, SAXException
private void parseInputStream(InputStream aStream)
throws IOException, SAXException
{
final Reader configReader =
new BufferedReader(new FileReader(aFilename), TWO_KB);
final InputSource inputSource = new InputSource(configReader);
final InputStream configStream =
new BufferedInputStream(aStream, TWO_KB);
final InputSource inputSource = new InputSource(configStream);
parseInputSource(inputSource);
configReader.close();
}
///////////////////////////////////////////////////////////////////////////
@ -154,35 +157,47 @@ class ConfigurationLoader
/**
* Returns the check configurations in a specified file.
* @param aConfigFname name of config file
* @param aConfig name of config file
* @param aOverrideProps overriding properties
* @return the check configurations
* @throws CheckstyleException if an error occurs
*/
public static Configuration loadConfiguration(String aConfigFname,
Properties aOverrideProps)
public static Configuration loadConfiguration(
String aConfig, Properties aOverrideProps)
throws CheckstyleException
{
try {
final ConfigurationLoader loader =
new ConfigurationLoader(aOverrideProps);
loader.parseFile(aConfigFname);
// figure out if this is a File or a URL
InputStream configStream;
try {
URL url = new URL(aConfig);
configStream = url.openStream();
}
catch (MalformedURLException ex) {
configStream = new FileInputStream(aConfig);
}
final InputStream bufferedStream =
new BufferedInputStream(configStream);
loader.parseInputStream(bufferedStream);
bufferedStream.close();
return loader.getConfiguration();
}
catch (FileNotFoundException e) {
throw new CheckstyleException(
"unable to find " + aConfigFname, e);
"unable to find " + aConfig, e);
}
catch (ParserConfigurationException e) {
throw new CheckstyleException(
"unable to parse " + aConfigFname, e);
"unable to parse " + aConfig, e);
}
catch (SAXException e) {
throw new CheckstyleException("unable to parse "
+ aConfigFname + " - " + e.getMessage(), e);
+ aConfig + " - " + e.getMessage(), e);
}
catch (IOException e) {
throw new CheckstyleException("unable to read " + aConfigFname, e);
throw new CheckstyleException("unable to read " + aConfig, e);
}
}