Module edu.hm.hafner.analysis.model

Package edu.hm.hafner.analysis.parser.checkstyle

Class CheckStyleRules

java.lang.Object

edu.hm.hafner.analysis.parser.checkstyle.CheckStyleRules

public class CheckStyleRules
extends Object

Reads the meta data of the Checkstyle rules from the DocBook files of the Checkstyle distribution.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
CheckStyleRules()	Loads the available rules into a map.

Method Summary

Modifier and Type	Method	Description
String	getDescription(String name)	Returns the description of the Checkstyle rule with the specified name.
Rule	getRule(String name)	Returns the Checkstyle rule with the specified name.
Collection<Rule>	getRules()	Returns all Checkstyle rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckStyleRules

public CheckStyleRules()

Loads the available rules into a map.

Method Details

getRules

public Collection<Rule> getRules()

Returns all Checkstyle rules.

Returns:

all Checkstyle rules

getRule

public Rule getRule(String name)

Returns the Checkstyle rule with the specified name.

Parameters:

name - the name of the rule

Returns:

the Checkstyle rule with the specified name.

getDescription

public String getDescription(String name)

Returns the description of the Checkstyle rule with the specified name.

Parameters:

name - the name of the rule

Returns:

the description for the specified rule