|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.cogroo.tools.checker.JavaRuleDefinition
public class JavaRuleDefinition
Implementation of RuleDefinitionI to be used in Java based rules. This is used to display human readable information about the rules in places like Cogroo Comunidade
| Constructor Summary | |
|---|---|
JavaRuleDefinition(String id,
String category,
String group,
String description,
String message,
String shortMessage,
List<Example> examples)
Creates a new Java rule definition |
|
| 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 |
RuleType |
getRuleType()
Will always return RuleType.JAVA |
String |
getShortMessage()
short error message generated by this rule |
boolean |
isXMLBased()
Will allways return false |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public JavaRuleDefinition(String id,
String category,
String group,
String description,
String message,
String shortMessage,
List<Example> examples)
id - prefixed identifiercategory - rule categorygroup - rule groupdescription - a descriptionmessage - long error message generated by this ruleshortMessage - short error message generated by this ruleexamples - examples of this errors catch by this rule| Method Detail |
|---|
public String getId()
RuleDefinition
getId in interface RuleDefinitionpublic String getCategory()
RuleDefinition
getCategory in interface RuleDefinitionpublic String getGroup()
RuleDefinition
getGroup in interface RuleDefinitionpublic String getDescription()
RuleDefinition
getDescription in interface RuleDefinitionpublic String getMessage()
RuleDefinition
getMessage in interface RuleDefinitionpublic String getShortMessage()
RuleDefinition
getShortMessage in interface RuleDefinitionpublic List<Example> getExamples()
RuleDefinition
getExamples in interface RuleDefinitionpublic RuleType getRuleType()
getRuleType in interface RuleDefinitionRuleDefinition.getRuleType()public boolean isXMLBased()
isXMLBased in interface RuleDefinitionRuleDefinition.isXMLBased()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||