Package org.codenarc.rule.comments
Class ClassJavadocRule
java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.comments.ClassJavadocRule
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
applyTo
(SourceCode sourceCode, List<Violation> violations) Apply this rule to the specified source and return a list of violations (or an empty List)boolean
groovy.lang.MetaClass
getName()
int
getProperty
(String property) invokeMethod
(String method, Object arguments) boolean
void
setApplyToNonMainClasses
(boolean value) void
setMetaClass
(groovy.lang.MetaClass mc) void
Set the unique name for this rulevoid
setPriority
(int value) Set the priority for this rulevoid
setProperty
(String property, Object value) protected String
sourceCodeNameWithoutExtension
(SourceCode sourceCode) Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
Constructor Details
-
ClassJavadocRule
public ClassJavadocRule()
-
-
Method Details
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc) - Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
-
invokeMethod
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
Description copied from class:AbstractRule
Set the unique name for this rule- Specified by:
setName
in classAbstractRule
- Parameters:
value
- - the name for this rule; this should be unique
-
getPriority
public int getPriority()- Specified by:
getPriority
in interfaceRule
- Specified by:
getPriority
in classAbstractRule
- 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 classAbstractRule
- 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
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 classAbstractRule
- Parameters:
sourceCode
- - the source to apply this rule toviolations
- - the List of violations to which new violations from this rule are to be added
-
sourceCodeNameWithoutExtension
-