Rule (Static Analysis Model and Parsers 10.10.0 API)

java.lang.Object
- edu.hm.hafner.analysis.parser.checkstyle.Rule

```
public class Rule
extends Object
```
Java Bean class representing a Checkstyle rule.

Author:

Ullrich Hafner

Constructor Summary

Constructors
Constructor Description

Rule()
Instantiates a new rule.

Rule(String name)
Instantiates a new rule.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.

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(@CheckForNull
            String name)
```
    Instantiates a new rule.
    
    Parameters:
    
    name - the name of the rule
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of this rule.
    
    Returns:
    
    the name
  - setName
```
public void setName(@CheckForNull
                    String name)
```
    Sets the name of this rule.
    
    Parameters:
    
    name - the name
  - getDescription
```
public 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