net.sourceforge.pmd
Interface Rule

All Known Implementing Classes:
AbstractRule, JUnitAssertionsShouldIncludeMessageRule, SymbolTableTestRule, UnnecessaryConversionTemporaryRule

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

public static final int LOWEST_PRIORITY
See Also:
Constant Field Values

PRIORITIES

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

getName

public java.lang.String getName()

getMessage

public java.lang.String getMessage()

getDescription

public java.lang.String getDescription()

getExample

public java.lang.String getExample()

setName

public void setName(java.lang.String name)

setMessage

public void setMessage(java.lang.String message)

setDescription

public void setDescription(java.lang.String description)

setExample

public void setExample(java.lang.String example)

apply

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

hasProperty

public boolean hasProperty(java.lang.String name)

addProperty

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

getIntProperty

public int getIntProperty(java.lang.String name)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)

getStringProperty

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

getDoubleProperty

public double getDoubleProperty(java.lang.String name)

getProperties

public RuleProperties getProperties()

include

public boolean include()

setInclude

public void setInclude(boolean include)

getPriority

public int getPriority()

getPriorityName

public java.lang.String getPriorityName()

setPriority

public void setPriority(int priority)


Copyright © 2002-2003 Project Ultra*Log @ DARPA. All Rights Reserved.