org.acm.seguin.pmd
Interface Rule

All Known Implementing Classes:
AbstractRule, AccessorClassGenerationRule, AtLeastOneConstructorRule, AvoidCatchingThrowable, AvoidDeeplyNestedIfStmtsRule, AvoidDuplicateLiteralsRule, AvoidReassigningParametersRule, AvoidWritingToArrayParametersRule, BeanMembersShouldSerializeRule, ClassNamingConventionsRule, ConstructorCallsOverridableMethodRule, CouplingBetweenObjectsRule, CyclomaticComplexityRule, DoubleCheckedLockingRule, DuplicateImportsRule, ExceptionSignatureDeclaration, ExceptionTypeChecking, ExcessiveImportsRule, ExcessiveLengthRule, ExcessiveNodeCountRule, ExcessivePublicCountRule, IdempotentOperationsRule, ImportFromSamePackageRule, JUnitAssertionsShouldIncludeMessageRule, LongClassRule, LongMethodRule, LongParameterListRule, LooseCouplingRule, MethodNamingConventionsRule, NullAssignmentRule, OnlyOneReturnRule, PositionalIteratorRule, SimplifyBooleanReturnsRule, StatisticalRule, StringConcatenationRule, StringToStringRule, SwitchDensityRule, SymbolTableTestRule, UnnecessaryConversionTemporaryRule, UnusedFormalParameterRule, UnusedImportsRule, UnusedLocalVariableRule, UnusedPrivateFieldRule, UnusedPrivateMethodRule, UseSingletonRule, VariableNamingConventionsRule

public interface Rule


Field Summary
static int LOWEST_PRIORITY
           
static java.lang.String[] PRIORITIES
           
 
Method Summary
 void addProperty(java.lang.String name, java.lang.String property)
           
 void apply(java.util.List astCompilationUnits, RuleContext ctx)
           
 boolean getBooleanProperty(java.lang.String name)
           
 java.lang.String getDescription()
           
 double getDoubleProperty(java.lang.String name)
           
 java.lang.String getExample()
           
 int getIntProperty(java.lang.String name)
           
 java.lang.String getMessage()
           
 java.lang.String getName()
           
 int getPriority()
           
 java.lang.String getPriorityName()
           
 RuleProperties getProperties()
           
 java.lang.String getStringProperty(java.lang.String name)
           
 boolean hasProperty(java.lang.String name)
           
 boolean include()
           
 void setDescription(java.lang.String description)
           
 void setExample(java.lang.String example)
           
 void setInclude(boolean include)
           
 void setMessage(java.lang.String message)
           
 void setName(java.lang.String name)
           
 void setPriority(int priority)
           
 

Field Detail

LOWEST_PRIORITY

static final int LOWEST_PRIORITY
See Also:
Constant Field Values

PRIORITIES

static final java.lang.String[] PRIORITIES
Method Detail

getName

java.lang.String getName()

getMessage

java.lang.String getMessage()

getDescription

java.lang.String getDescription()

getExample

java.lang.String getExample()

setName

void setName(java.lang.String name)

setMessage

void setMessage(java.lang.String message)

setDescription

void setDescription(java.lang.String description)

setExample

void setExample(java.lang.String example)

apply

void apply(java.util.List astCompilationUnits,
           RuleContext ctx)

hasProperty

boolean hasProperty(java.lang.String name)

addProperty

void addProperty(java.lang.String name,
                 java.lang.String property)

getIntProperty

int getIntProperty(java.lang.String name)

getBooleanProperty

boolean getBooleanProperty(java.lang.String name)

getStringProperty

java.lang.String getStringProperty(java.lang.String name)

getDoubleProperty

double getDoubleProperty(java.lang.String name)

getProperties

RuleProperties getProperties()

include

boolean include()

setInclude

void setInclude(boolean include)

getPriority

int getPriority()

getPriorityName

java.lang.String getPriorityName()

setPriority

void setPriority(int priority)