org.cogroo.tools.checker
Class AbstractGenericChecker<T>

java.lang.Object
  extended by org.cogroo.tools.checker.AbstractGenericChecker<T>
All Implemented Interfaces:
GenericChecker<T>
Direct Known Subclasses:
AbstractChecker, AbstractTypedChecker

public abstract class AbstractGenericChecker<T>
extends Object
implements GenericChecker<T>


Constructor Summary
AbstractGenericChecker()
           
 
Method Summary
 AbstractGenericChecker add(RuleDefinition ruleDefinition)
           
 RuleDefinition getRuleDefinition(String ruleID)
           
 Collection<RuleDefinition> getRulesDefinition()
          Returns the descriptions of the rules implemented by this checker.
 void ignore(String id)
          The checker should ignore the rule with the given id.
 void resetIgnored()
          Reset all ignored rules
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.cogroo.tools.checker.GenericChecker
check, getIdPrefix, getPriority
 

Constructor Detail

AbstractGenericChecker

public AbstractGenericChecker()
Method Detail

ignore

public void ignore(String id)
Description copied from interface: GenericChecker
The checker should ignore the rule with the given id. IDs of a checker have a fixed prefix.

Specified by:
ignore in interface GenericChecker<T>
Parameters:
id - the rule id to be ignored

resetIgnored

public void resetIgnored()
Description copied from interface: GenericChecker
Reset all ignored rules

Specified by:
resetIgnored in interface GenericChecker<T>

add

public AbstractGenericChecker add(RuleDefinition ruleDefinition)

getRuleDefinition

public RuleDefinition getRuleDefinition(String ruleID)

getRulesDefinition

public Collection<RuleDefinition> getRulesDefinition()
Description copied from interface: GenericChecker
Returns the descriptions of the rules implemented by this checker.

Specified by:
getRulesDefinition in interface GenericChecker<T>
Returns:
a list of descriptions


Copyright © 2012-2013 CoGrOO. All Rights Reserved.