Modul edu.hm.hafner.analysis.model

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

Klasse Rule

java.lang.Object

edu.hm.hafner.analysis.parser.checkstyle.Rule

public class Rule
extends Object

Java Bean class representing a Checkstyle rule.

Autor:

Ullrich Hafner

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Rule()	Instantiates a new rule.
Rule(String name)	Instantiates a new rule.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getDescription()	Returns the description of this rule.
String	getName()	Returns the name of this rule.
void	setDescription(Topic topic)	Sets the description of this rule.
void	setName(String name)	Sets the name of this rule.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

Rule

public Rule()

Instantiates a new rule.

Rule

public Rule(@CheckForNull
 String name)

Instantiates a new rule.

Parameter:

name - the name of the rule

Methodendetails

getName

public String getName()

Returns the name of this rule.

Gibt zurück:

the name

setName

public void setName(@CheckForNull
 String name)

Sets the name of this rule.

Parameter:

name - the name

getDescription

public String getDescription()

Returns the description of this rule.

Gibt zurück:

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.

Parameter:

topic - the topic that might contain the description