|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.pmd.PMD
public class PMD
Field Summary | |
---|---|
static java.lang.String |
EOL
|
static java.lang.String |
EXCLUDE_MARKER
|
static java.lang.String |
VERSION
|
Constructor Summary | |
---|---|
PMD()
|
Method Summary | |
---|---|
static void |
main(java.lang.String[] args)
|
void |
processFile(java.io.InputStream fileContents,
RuleSet ruleSet,
RuleContext ctx)
Processes the input stream against a rule set assuming the platform character set. |
void |
processFile(java.io.InputStream fileContents,
java.lang.String encoding,
RuleSet ruleSet,
RuleContext ctx)
Processes the input stream agains a rule set using the given input encoding. |
void |
processFile(java.io.InputStream fileContents,
java.lang.String encoding,
RuleSets ruleSets,
RuleContext ctx)
Processes the input stream agains a rule set using the given input encoding. |
void |
processFile(java.io.Reader reader,
RuleSet ruleSet,
RuleContext ctx)
Processes the file read by the reader agains the rule set. |
void |
processFile(java.io.Reader reader,
RuleSets ruleSets,
RuleContext ctx)
Processes the file read by the reader agains the rule set. |
void |
processFile(java.io.Reader reader,
RuleSets ruleSets,
RuleContext ctx,
SourceType sourceType)
Processes the file read by the reader against the rule set. |
static void |
processFiles(int threadCount,
RuleSetFactory ruleSetFactory,
SourceType sourceType,
java.util.List<DataSource> files,
RuleContext ctx,
java.util.List<Renderer> renderers,
java.lang.String rulesets,
boolean shortNamesEnabled,
java.lang.String inputPath,
java.lang.String encoding,
java.lang.String excludeMarker)
Run PMD on a list of files using multiple threads. |
void |
processFiles(java.util.List<DataSource> files,
RuleContext ctx,
RuleSets rulesets,
boolean debugEnabled,
boolean shortNamesEnabled,
java.lang.String inputPath,
java.lang.String encoding)
Run PMD on a list of files. |
void |
setExcludeMarker(java.lang.String marker)
|
void |
setJavaVersion(SourceType javaVersion)
Set the SourceType to be used for ".java" files. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String EOL
public static final java.lang.String VERSION
public static final java.lang.String EXCLUDE_MARKER
Constructor Detail |
---|
public PMD()
Method Detail |
---|
public void processFile(java.io.Reader reader, RuleSets ruleSets, RuleContext ctx) throws PMDException
reader
- input stream readerruleSets
- set of rules to process against the filectx
- context in which PMD is operating. This contains the Renderer and
whatnot
PMDException
- if the input could not be parsed or processedpublic void processFile(java.io.Reader reader, RuleSets ruleSets, RuleContext ctx, SourceType sourceType) throws PMDException
reader
- input stream readerruleSets
- set of rules to process against the filectx
- context in which PMD is operating. This contains the Renderer and
whatnotsourceType
- the SourceType of the source
PMDException
- if the input could not be parsed or processedpublic void processFile(java.io.Reader reader, RuleSet ruleSet, RuleContext ctx) throws PMDException
reader
- input stream readerruleSet
- set of rules to process against the filectx
- context in which PMD is operating. This contains the Renderer and
whatnot
PMDException
- if the input could not be parsed or processedpublic void processFile(java.io.InputStream fileContents, java.lang.String encoding, RuleSet ruleSet, RuleContext ctx) throws PMDException
fileContents
- an input stream to analyzeencoding
- input stream's encodingruleSet
- set of rules to process against the filectx
- context in which PMD is operating. This contains the Report and whatnot
PMDException
- if the input encoding is unsupported or the input stream could
not be parsedprocessFile(Reader, RuleSet, RuleContext)
public void processFile(java.io.InputStream fileContents, java.lang.String encoding, RuleSets ruleSets, RuleContext ctx) throws PMDException
fileContents
- an input stream to analyzeencoding
- input stream's encodingruleSets
- set of rules to process against the filectx
- context in which PMD is operating. This contains the Report and whatnot
PMDException
- if the input encoding is unsupported or the input stream could
not be parsedprocessFile(Reader, RuleSet, RuleContext)
public void processFile(java.io.InputStream fileContents, RuleSet ruleSet, RuleContext ctx) throws PMDException
fileContents
- input stream to checkruleSet
- the set of rules to process against the source codectx
- the context in which PMD is operating. This contains the Report and
whatnot
PMDException
- if the input encoding is unsupported or the input input stream
could not be parsedprocessFile(InputStream, String, RuleSet, RuleContext)
public void setExcludeMarker(java.lang.String marker)
public void setJavaVersion(SourceType javaVersion)
javaVersion
- the SourceType that indicates the java versionpublic static void main(java.lang.String[] args)
public static void processFiles(int threadCount, RuleSetFactory ruleSetFactory, SourceType sourceType, java.util.List<DataSource> files, RuleContext ctx, java.util.List<Renderer> renderers, java.lang.String rulesets, boolean shortNamesEnabled, java.lang.String inputPath, java.lang.String encoding, java.lang.String excludeMarker)
java.io.IOException
- If one of the files could not be readpublic void processFiles(java.util.List<DataSource> files, RuleContext ctx, RuleSets rulesets, boolean debugEnabled, boolean shortNamesEnabled, java.lang.String inputPath, java.lang.String encoding) throws java.io.IOException
files
- the List of DataSource instances.ctx
- the context in which PMD is operating. This contains the Report and
whatnotrulesets
- the RuleSetsdebugEnabled
- shortNamesEnabled
- inputPath
- encoding
-
java.io.IOException
- If one of the files could not be read
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |