Package org.codenarc.rule.generic
Class RequiredStringRule
- java.lang.Object
-
- org.codenarc.rule.AbstractRule
-
- org.codenarc.rule.generic.RequiredStringRule
-
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
public class RequiredStringRule extends AbstractRule implements groovy.lang.GroovyObject
-
-
Constructor Summary
Constructors Constructor Description RequiredStringRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
applyTo(SourceCode sourceCode, List<Violation> violations)
Apply this rule to the specified source and return a list of violations (or an empty List)groovy.lang.MetaClass
getMetaClass()
String
getName()
int
getPriority()
Object
getProperty(String property)
String
getString()
Object
invokeMethod(String method, Object arguments)
boolean
isReady()
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.void
setMetaClass(groovy.lang.MetaClass mc)
void
setName(String value)
Set the unique name for this rulevoid
setPriority(int value)
Set the priority for this rulevoid
setProperty(String property, Object value)
void
setString(String value)
-
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
-
-
-
Method Detail
-
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
public Object invokeMethod(String method, Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
public Object getProperty(String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
public void setProperty(String property, Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
public String getName()
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- 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 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.
-
getString
public String getString()
-
setString
public void setString(String value)
-
isReady
public boolean isReady()
Description copied from class:AbstractRule
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied. Return true by default. This method is provided as a placeholder so subclasses can optionally override.- Overrides:
isReady
in classAbstractRule
- Returns:
- true if all preconditions for this rule are satisfied
-
applyTo
public void applyTo(SourceCode sourceCode, List<Violation> 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 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
-
-