hudson.plugins.checkstyle.rules
Class CheckStyleRules

java.lang.Object
  hudson.plugins.checkstyle.rules.CheckStyleRules

public final class CheckStyleRules
extends java.lang.Object

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

Author:

Ulli Hafner

Method Summary

java.lang.String	getDescription(java.lang.String name) Returns the description of the Checkstyle rule with the specified name.
static CheckStyleRules	getInstance() Returns the singleton instance.
Rule	getRule(java.lang.String name) Returns the Checkstyle rule with the specified name.
java.util.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

Method Detail

getInstance

public static CheckStyleRules getInstance()

Returns the singleton instance.

Returns:

the singleton instance

getRules

public java.util.Collection<Rule> getRules()

Returns all Checkstyle rules.

Returns:

all Checkstyle rules

getRule

public Rule getRule(java.lang.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 java.lang.String getDescription(java.lang.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 .