net.sourceforge.pmd
Class PMD

java.lang.Object
  net.sourceforge.pmd.PMD

public class PMD

extends java.lang.Object

Field Summary

static java.lang.String	EOL
static java.lang.String	VERSION

Constructor Summary

PMD()

PMD(TargetJDKVersion targetJDKVersion)

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.Reader reader, RuleSet ruleSet, RuleContext ctx) Processes the file read by the reader agains the rule set.
void	setExcludeMarker(java.lang.String marker)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EOL

public static final java.lang.String EOL

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

PMD

public PMD()

PMD

public PMD(TargetJDKVersion targetJDKVersion)

Method Detail

processFile

public void processFile(java.io.Reader reader,
                        RuleSet ruleSet,
                        RuleContext ctx)
                 throws PMDException

Processes the file read by the reader agains the rule set.

Parameters:

reader - input stream reader

ruleSet - set of rules to process against the file

ctx - context in which PMD is operating. This contains the Renderer and whatnot

Throws:

PMDException - if the input could not be parsed or processed

processFile

public void processFile(java.io.InputStream fileContents,
                        java.lang.String encoding,
                        RuleSet ruleSet,
                        RuleContext ctx)
                 throws PMDException

Processes the input stream agains a rule set using the given input encoding.

Parameters:

fileContents - an input stream to analyze

encoding - input stream's encoding

ruleSet - set of rules to process against the file

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 could not be parsed

See Also:

processFile(Reader, RuleSet, RuleContext)

processFile

public void processFile(java.io.InputStream fileContents,
                        RuleSet ruleSet,
                        RuleContext ctx)
                 throws PMDException

Processes the input stream against a rule set assuming the platform character set.

Parameters:

fileContents - input stream to check

ruleSet - the set of rules to process against the source code

ctx - the context in which PMD is operating. This contains the Report and whatnot

Throws:

PMDException - if the input encoding is unsupported or the input input stream could not be parsed

See Also:

processFile(InputStream, String, RuleSet, RuleContext)

setExcludeMarker

public void setExcludeMarker(java.lang.String marker)

main

public static void main(java.lang.String[] args)