org.codenarc.rule.formatting
Class ClassJavadocRule

java.lang.Object
  org.codenarc.rule.AbstractRule
      org.codenarc.rule.formatting.ClassJavadocRule

All Implemented Interfaces:

groovy.lang.GroovyObject, Rule

public class ClassJavadocRule
extends AbstractRule
implements groovy.lang.GroovyObject

Constructor Summary

ClassJavadocRule()

Method Summary

void	applyTo(SourceCode sourceCode, List violations) Apply this rule to the specified source and return a list of violations (or an empty List)
boolean	getApplyToNonMainClasses()
groovy.lang.MetaClass	getMetaClass()
String	getName()
int	getPriority()
Object	getProperty(String property)
Object	invokeMethod(String method, Object arguments)
boolean	isApplyToNonMainClasses()
void	setApplyToNonMainClasses(boolean value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setName(String value) Set the unique name for this rule
void	setPriority(int value) Set the priority for this rule
void	setProperty(String property, Object value)

Methods inherited from class org.codenarc.rule.AbstractRule

applyTo, createViolation, createViolation, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassJavadocRule

public ClassJavadocRule()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

getName

public String getName()

Specified by:

getName in interface Rule

Specified by:

getName in class AbstractRule

Returns:

the unique name for this rule

setName

public void setName(String value)

Description copied from class: AbstractRule

Set the unique name for this rule

Specified by:

setName in class AbstractRule

Parameters:

value - - the name for this rule; this should be unique

getPriority

public int getPriority()

Specified by:

getPriority in interface Rule

Specified by:

getPriority in class AbstractRule

Returns:

the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

setPriority

public void setPriority(int value)

Description copied from class: AbstractRule

Set the priority for this rule

Specified by:

setPriority in class AbstractRule

Parameters:

value - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

getApplyToNonMainClasses

public boolean getApplyToNonMainClasses()

isApplyToNonMainClasses

public boolean isApplyToNonMainClasses()

setApplyToNonMainClasses

public void setApplyToNonMainClasses(boolean value)

applyTo

public void applyTo(SourceCode sourceCode,
                    List violations)

Description copied from class: AbstractRule

Apply this rule to the specified source and return a list of violations (or an empty List)

Specified by:

applyTo in class AbstractRule

Parameters:

sourceCode - - the source to apply this rule to

violations - - the List of violations to which new violations from this rule are to be added