| java.lang.Object
 net.sourceforge.pmd.PMD
| Constructor Summary | |
| public | PMD()
|
| Method Summary | |
| public ClassLoader | getClassLoader()
Get the ClassLoader being used by PMD when processing Rules. | | public static void | main(String[] args)
| | public void | processFile(Reader reader, RuleSets ruleSets, RuleContext ctx)
Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. | | public void | processFile(Reader reader, RuleSets ruleSets, RuleContext ctx, SourceType sourceType)
Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. | | public void | processFile(Reader reader, RuleSet ruleSet, RuleContext ctx)
Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSet - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. | | public void | processFile(InputStream fileContents, String encoding, RuleSet ruleSet, RuleContext ctx)
Processes the input stream against a rule set using the given input encoding.
Parameters:
fileContents - an input stream to analyze
Parameters:
encoding - input stream's encoding
Parameters:
ruleSet - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. | | public void | processFile(InputStream fileContents, String encoding, RuleSets ruleSets, RuleContext ctx)
Processes the input stream against a rule set using the given input encoding.
Parameters:
fileContents - an input stream to analyze
Parameters:
encoding - input stream's encoding
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. | | public void | processFile(InputStream fileContents, RuleSet ruleSet, RuleContext ctx)
Processes the input stream against a rule set assuming the platform character set.
Parameters:
fileContents - input stream to check
Parameters:
ruleSet - the set of rules to process against the source code
Parameters:
ctx - the context in which PMD is operating. | | public static void | processFiles(int threadCount, RuleSetFactory ruleSetFactory, SourceType sourceType, List<DataSource> files, RuleContext ctx, List<Renderer> renderers, String rulesets, boolean shortNamesEnabled, String inputPath, String encoding, String excludeMarker, ClassLoader classLoader)
Run PMD on a list of files using multiple threads. | | public static void | processFiles(int threadCount, RuleSetFactory ruleSetFactory, SourceType sourceType, List<DataSource> files, RuleContext ctx, List<Renderer> renderers, boolean stressTestEnabled, String rulesets, boolean shortNamesEnabled, String inputPath, String encoding, String excludeMarker, ClassLoader classLoader)
Run PMD on a list of files using multiple threads. | | public void | processFiles(List<DataSource> files, RuleContext ctx, RuleSets rulesets, boolean debugEnabled, boolean shortNamesEnabled, String inputPath, String encoding)
Run PMD on a list of files.
Parameters:
files - the List of DataSource instances.
Parameters:
ctx - the context in which PMD is operating. | | public void | setClassLoader(ClassLoader classLoader)
Set the ClassLoader being used by PMD when processing Rules. | | public void | setExcludeMarker(String marker)
| | public void | setJavaVersion(SourceType javaVersion)
Set the SourceType to be used for ".java" files. |
| EXCLUDE_MARKER | | final public static String EXCLUDE_MARKER(Code) | | |
| getClassLoader | | public ClassLoader getClassLoader()(Code) | | Get the ClassLoader being used by PMD when processing Rules.
The ClassLoader being used |
| processFile | | public void processFile(Reader reader, RuleSets ruleSets, RuleContext ctx) throws PMDException(Code) | | Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. This contains the Renderer andwhatnot
throws:
PMDException - if the input could not be parsed or processed |
| processFile | | public void processFile(Reader reader, RuleSets ruleSets, RuleContext ctx, SourceType sourceType) throws PMDException(Code) | | Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. This contains the Renderer andwhatnot
Parameters:
sourceType - the SourceType of the source
throws:
PMDException - if the input could not be parsed or processed |
| processFile | | public void processFile(Reader reader, RuleSet ruleSet, RuleContext ctx) throws PMDException(Code) | | Processes the file read by the reader against the rule set.
Parameters:
reader - input stream reader
Parameters:
ruleSet - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. This contains the Renderer andwhatnot
throws:
PMDException - if the input could not be parsed or processed |
| processFile | | public void processFile(InputStream fileContents, String encoding, RuleSet ruleSet, RuleContext ctx) throws PMDException(Code) | | Processes the input stream against a rule set using the given input encoding.
Parameters:
fileContents - an input stream to analyze
Parameters:
encoding - input stream's encoding
Parameters:
ruleSet - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. This contains the Report and whatnot
throws:
PMDException - if the input encoding is unsupported or the input stream couldnot be parsed
See Also: PMD.processFile(Reader,RuleSet,RuleContext) |
| processFile | | public void processFile(InputStream fileContents, String encoding, RuleSets ruleSets, RuleContext ctx) throws PMDException(Code) | | Processes the input stream against a rule set using the given input encoding.
Parameters:
fileContents - an input stream to analyze
Parameters:
encoding - input stream's encoding
Parameters:
ruleSets - set of rules to process against the file
Parameters:
ctx - context in which PMD is operating. This contains the Report and whatnot
throws:
PMDException - if the input encoding is unsupported or the input stream couldnot be parsed
See Also: PMD.processFile(Reader,RuleSet,RuleContext) |
| processFile | | public void processFile(InputStream fileContents, RuleSet ruleSet, RuleContext ctx) throws PMDException(Code) | | Processes the input stream against a rule set assuming the platform character set.
Parameters:
fileContents - input stream to check
Parameters:
ruleSet - the set of rules to process against the source code
Parameters:
ctx - the context in which PMD is operating. This contains the Report andwhatnot
throws:
PMDException - if the input encoding is unsupported or the input input streamcould not be parsed
See Also: PMD.processFile(InputStream,String,RuleSet,RuleContext) |
| processFiles | | public static void processFiles(int threadCount, RuleSetFactory ruleSetFactory, SourceType sourceType, List<DataSource> files, RuleContext ctx, List<Renderer> renderers, String rulesets, boolean shortNamesEnabled, String inputPath, String encoding, String excludeMarker, ClassLoader classLoader)(Code) | | Run PMD on a list of files using multiple threads.
throws:
IOException - If one of the files could not be read |
| processFiles | | public static void processFiles(int threadCount, RuleSetFactory ruleSetFactory, SourceType sourceType, List<DataSource> files, RuleContext ctx, List<Renderer> renderers, boolean stressTestEnabled, String rulesets, boolean shortNamesEnabled, String inputPath, String encoding, String excludeMarker, ClassLoader classLoader)(Code) | | Run PMD on a list of files using multiple threads.
throws:
IOException - If one of the files could not be read |
| processFiles | | public void processFiles(List<DataSource> files, RuleContext ctx, RuleSets rulesets, boolean debugEnabled, boolean shortNamesEnabled, String inputPath, String encoding) throws IOException(Code) | | Run PMD on a list of files.
Parameters:
files - the List of DataSource instances.
Parameters:
ctx - the context in which PMD is operating. This contains the Report andwhatnot
Parameters:
rulesets - the RuleSets
Parameters:
debugEnabled -
Parameters:
shortNamesEnabled -
Parameters:
inputPath -
Parameters:
encoding -
throws:
IOException - If one of the files could not be read |
| setClassLoader | | public void setClassLoader(ClassLoader classLoader)(Code) | | Set the ClassLoader being used by PMD when processing Rules.
Setting a value of null will cause the default
ClassLoader to be used.
Parameters:
classLoader - The ClassLoader to use |
| setExcludeMarker | | public void setExcludeMarker(String marker)(Code) | | |
| setJavaVersion | | public void setJavaVersion(SourceType javaVersion)(Code) | | Set the SourceType to be used for ".java" files.
Parameters:
javaVersion - the SourceType that indicates the java version |
|
|