org.codehaus.mojo.macker
Interface Macker

All Known Implementing Classes:

ForkedMacker, LinkedMacker

public interface Macker

Abstraction of the Macker tool. There is a linked and a forked implementation.

Author:

Peter Kofler

Method Summary

void	addClass(File clazz) Add a class to be checked by Macker.
void	addRulesFile(File rule) Add a rule file to be used by Macker.
void	check()
void	setAngerThreshold(String anger)
void	setPrintMaxMessages(int maxMsg)
void	setPrintThreshold(String print)
void	setVariable(String name, String value)
void	setVerbose(boolean verbose)
void	setXmlReportFile(File report) Set the XML report file to be used by Macker.

Method Detail

addClass

void addClass(File clazz)
              throws IOException,
                     MojoExecutionException

Add a class to be checked by Macker.

Throws:

IOException - if there's a problem reading a file

MojoExecutionException - if there's a problem parsing a class

addRulesFile

void addRulesFile(File rule)
                  throws IOException,
                         MojoExecutionException

Add a rule file to be used by Macker.

Throws:

IOException - if there's a problem reading a file

MojoExecutionException - if there's a problem parsing a rule file

check

void check()
           throws MojoExecutionException,
                  MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

setAngerThreshold

void setAngerThreshold(String anger)

setPrintMaxMessages

void setPrintMaxMessages(int maxMsg)

setPrintThreshold

void setPrintThreshold(String print)

setVariable

void setVariable(String name,
                 String value)

setVerbose

void setVerbose(boolean verbose)

setXmlReportFile

void setXmlReportFile(File report)
                      throws IOException

Set the XML report file to be used by Macker.

Throws:

IOException - if there's a problem with the report file