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

java.lang.Object
  extended by org.cogroo.tools.checker.GenericCheckerComposite<T>
All Implemented Interfaces:
GenericChecker<T>
Direct Known Subclasses:
CheckerComposite, TypedCheckerComposite

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


Constructor Summary
GenericCheckerComposite(List<GenericChecker<T>> aChildCheckers)
           
GenericCheckerComposite(List<GenericChecker<T>> aChildCheckers, boolean aAllowOverlaps)
           
 
Method Summary
 String getIdPrefix()
          Each checker should have IDs with a fixed prefix so CheckerComposite can route the ignore message to the correct checker.
 int getPriority()
          Priority of this checker.
 List<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
 

Constructor Detail

GenericCheckerComposite

public GenericCheckerComposite(List<GenericChecker<T>> aChildCheckers)

GenericCheckerComposite

public GenericCheckerComposite(List<GenericChecker<T>> aChildCheckers,
                               boolean aAllowOverlaps)
Method Detail

getIdPrefix

public String getIdPrefix()
Description copied from interface: GenericChecker
Each checker should have IDs with a fixed prefix so CheckerComposite can route the ignore message to the correct checker.

Specified by:
getIdPrefix in interface GenericChecker<T>
Returns:
the id prefix

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>

getPriority

public int getPriority()
Description copied from interface: GenericChecker
Priority of this checker. The higher is the number the higher is its priority

Specified by:
getPriority in interface GenericChecker<T>
Returns:
the priority of this checker

getRulesDefinition

public List<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.