org.cogroo.tools.checker

Interface RuleDefinition

All Known Implementing Classes:

JavaRuleDefinition, XMLRuleDefinition

public interface RuleDefinition

Method Summary

Modifier and Type	Method and Description
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
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.

Method Detail

getId

String getId()

prefixed identifier

Returns:

the prefixed identifier

getCategory

String getCategory()

rule category

Returns:

the rule category

getGroup

String getGroup()

rule group

Returns:

the rule group

getDescription

String getDescription()

a description

Returns:

a description

getRuleType

RuleType getRuleType()

short error message generated by this rule

Returns:

getMessage

String getMessage()

long error message generated by this rule

Returns:

the long error message generated by this rule

getShortMessage

String getShortMessage()

short error message generated by this rule

Returns:

short error message generated by this rule

getExamples

List<Example> getExamples()

examples of this errors catch by this rule

Returns:

examples of this errors catch by this rule

isXMLBased

boolean isXMLBased()

True if this definition is from a XML based rule.

Returns:

True if this definition is from a XML based rule.