Modul edu.hm.hafner.analysis.model

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

Klasse 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.

Autor:

Ullrich Hafner

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CheckStyleRules()	Loads the available rules into a map.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

CheckStyleRules

public CheckStyleRules()

Loads the available rules into a map.

Methodendetails

getRules

public Collection<Rule> getRules()

Returns all Checkstyle rules.

Gibt zurück:

all Checkstyle rules

getRule

public Rule getRule(String name)

Returns the Checkstyle rule with the specified name.

Parameter:

name - the name of the rule

Gibt zurück:

the Checkstyle rule with the specified name.

getDescription

public String getDescription(String name)

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

Parameter:

name - the name of the rule

Gibt zurück:

the description for the specified rule