Rule (CDC - Issues API 0.28.0 API)

java.lang.Object
- cdc.issues.rules.Rule

```
public class Rule
extends Object
```
Class used to describe a Rule.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Rule.Builder
Rule builder.

Field Summary

Fields
Modifier and Type Field Description

static Comparator<Rule> ID_COMPARATOR
Comparator of Rules based on their id.

Constructor Summary

Constructors
Modifier Constructor Description

protected Rule(Rule.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Rule.Builder`	`builder()`
`boolean`	`equals(Object object)`
`String`	`getDescription()`
`String`	`getDomain()`
`RuleId`	`getId()`
`String`	`getName()`
`<T extends Enum<T>> T`	`getName(Class<T> cls)`
`FormalParams`	`getParams()`
`Set<IssueSeverity>`	`getSeverities()`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ID_COMPARATOR
```
public static final Comparator<Rule> ID_COMPARATOR
```
    Comparator of Rules based on their id.
- Constructor Detail
  - Rule
```
protected Rule(Rule.Builder builder)
```
- Method Detail
  - getId
```
public RuleId getId()
```
    Returns:
    
    The rule identifier.
  - getDomain
```
public String getDomain()
```
    Returns:
    
    The rule domain.
  - getName
```
public String getName()
```
    Returns:
    
    The rule name.
  - getName
```
public <T extends Enum<T>> T getName(Class<T> cls)
```
    Type Parameters:
    
    T - The enum type.
    
    Parameters:
    
    cls - The enum class.
    
    Returns:
    
    The rule name as an enum.
  - getSeverities
```
public Set<IssueSeverity> getSeverities()
```
    Returns:
    
    The rule severities.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    The rule description.
  - getParams
```
public FormalParams getParams()
```
    Returns:
    
    The rule formal parameters.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - builder
```
public static Rule.Builder builder()
```