org.cogroo.tools.checker.rules.applier
Class XMLRuleDefinition

java.lang.Object
  extended by org.cogroo.tools.checker.rules.applier.XMLRuleDefinition
All Implemented Interfaces:
RuleDefinition

public class XMLRuleDefinition
extends Object
implements RuleDefinition


Constructor Summary
XMLRuleDefinition(String prefix, Rule rule)
           
 
Method Summary
 String getCategory()
          rule category
 String getDescription()
          a description
 List<Example> getExamples()
          examples of this errors catch by this rule
 String getGroup()
          rule group
 String getId()
          prefixed identifier
 String getMessage()
          long error message generated by this rule
 Pattern getPattern()
           
 RuleType getRuleType()
          short error message generated by this rule
 String getShortMessage()
          short error message generated by this rule
 boolean isXMLBased()
          True if this definition is from a XML based rule.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLRuleDefinition

public XMLRuleDefinition(String prefix,
                         Rule rule)
Method Detail

getId

public String getId()
Description copied from interface: RuleDefinition
prefixed identifier

Specified by:
getId in interface RuleDefinition
Returns:
the prefixed identifier

getCategory

public String getCategory()
Description copied from interface: RuleDefinition
rule category

Specified by:
getCategory in interface RuleDefinition
Returns:
the rule category

getGroup

public String getGroup()
Description copied from interface: RuleDefinition
rule group

Specified by:
getGroup in interface RuleDefinition
Returns:
the rule group

getDescription

public String getDescription()
Description copied from interface: RuleDefinition
a description

Specified by:
getDescription in interface RuleDefinition
Returns:
a description

getMessage

public String getMessage()
Description copied from interface: RuleDefinition
long error message generated by this rule

Specified by:
getMessage in interface RuleDefinition
Returns:
the long error message generated by this rule

getShortMessage

public String getShortMessage()
Description copied from interface: RuleDefinition
short error message generated by this rule

Specified by:
getShortMessage in interface RuleDefinition
Returns:
short error message generated by this rule

getExamples

public List<Example> getExamples()
Description copied from interface: RuleDefinition
examples of this errors catch by this rule

Specified by:
getExamples in interface RuleDefinition
Returns:
examples of this errors catch by this rule

getPattern

public Pattern getPattern()

getRuleType

public RuleType getRuleType()
Description copied from interface: RuleDefinition
short error message generated by this rule

Specified by:
getRuleType in interface RuleDefinition
Returns:

isXMLBased

public boolean isXMLBased()
Description copied from interface: RuleDefinition
True if this definition is from a XML based rule.

Specified by:
isXMLBased in interface RuleDefinition
Returns:
True if this definition is from a XML based rule.


Copyright © 2012-2013 CoGrOO. All Rights Reserved.