public abstract static class AbstractRule.UmlObjectsMissingDoc<T extends UmlObject> extends AbstractRule.AbstractRuleWithSubobjectsAndSkips<T>
Modifier and Type | Class and Description |
---|---|
static class |
Rule.Category
Category of the rule; usefull to classify problems.
|
static class |
Rule.Severity
How severe the violation of this rule is; useful to prioritise problems.
|
AbstractRule.AbstractRuleWithSubobjectsAndSkips<T extends UmlObject>, AbstractRule.UmlObjectsMissingDoc<T extends UmlObject>, AbstractRule.UmlObjectsWithBadCharacterInName<T extends UmlObject>, AbstractRule.UmlObjectsWithBadDocEnd<T extends UmlObject>, AbstractRule.UmlObjectsWithBadDocStart<T extends UmlObject>, AbstractRule.UmlObjectsWithUnallowedStereotype<T extends UmlObject>, AbstractRule.UmlObjectsWithUnallowedTagNames<T extends UmlObject>
Modifier | Constructor and Description |
---|---|
protected |
UmlObjectsMissingDoc(org.apache.log4j.Logger logger,
java.lang.String what) |
Modifier and Type | Method and Description |
---|---|
protected void |
doValidate(UmlObject o,
ModelIssues issues) |
java.util.EnumSet<Nature> |
getApplicability()
Returns all the natures of model elements for which the rule is applicable.
|
Rule.Category |
getCategory()
Returns rule category.
|
java.lang.String |
getHowToFix()
Returns the suggestion on how to fix the problem.
|
java.lang.String |
getHypothesis()
Returns what this rule is enforcing (and what was violated).
|
org.apache.log4j.Level |
getLogLevel()
Returns log level to use (likely: related with
getSeverity() ). |
Rule.Severity |
getSeverity()
Returns severity if this rule is violated.
|
void |
logDiagnosis(boolean verbose,
ModelIssues issues)
Logs the diagnosis.
|
getSubObjects, skipSubobjectValidation, skipValidation, validate
createIssue, createIssue, createIssue, getCategory, getHowToFix, getHypothesis, getLogLevel, getSeverity, logDiagnosis
protected UmlObjectsMissingDoc(org.apache.log4j.Logger logger, java.lang.String what)
protected final void doValidate(UmlObject o, ModelIssues issues)
Matches normative items that miss description.
doValidate
in class AbstractRule.AbstractRuleWithSubobjectsAndSkips<T extends UmlObject>
public Rule.Category getCategory()
public Rule.Severity getSeverity()
public java.lang.String getHypothesis()
public java.lang.String getHowToFix()
public void logDiagnosis(boolean verbose, ModelIssues issues)
verbose
- whether to log on console also validation steps with no errors.issues
- "collecting" parameter, to be filled within the method.public org.apache.log4j.Level getLogLevel()
getSeverity()
).public java.util.EnumSet<Nature> getApplicability()
Copyright 2009-2016 Tatjana (Tanja) Kostic