hudson.plugins.checkstyle.rules
Class Rule

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

public class Rule
extends java.lang.Object

Java Bean class representing a Checkstyle rule.

Author:

Ulli Hafner

Constructor Summary

Rule()
Instantiates a new rule.

Rule(java.lang.String name)
Instantiates a new rule.

Method Summary

java.lang.String	getDescription() Returns the description of this rule.
java.lang.String	getName() Returns the name of this rule.
void	setDescription(Topic topic) Sets the description of this rule.
void	setName(java.lang.String name) Sets the name of this rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule()

Instantiates a new rule.

Rule

public Rule(java.lang.String name)

Instantiates a new rule.

Parameters:

name - the name of the rule

Method Detail

getName

public java.lang.String getName()

Returns the name of this rule.

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the name of this rule.

Parameters:

name - the name

getDescription

public java.lang.String getDescription()

Returns the description of this rule.

Returns:

the description

setDescription

public void setDescription(Topic topic)

Sets the description of this rule. The description is only set if the topic is a description.

Parameters:

topic - the topic that might contain the description