Rule (CDC - Issues API 0.5.0 API)

java.lang.Object
- cdc.issues.api.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

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)`
`RuleParams`	`getParams()`
`IssueSeverity`	`getSeverity()`
`int`	`hashCode()`

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

- 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.
  - getSeverity
```
public IssueSeverity getSeverity()
```
    Returns:
    
    The rule severity.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    The rule description.
  - getParams
```
public RuleParams getParams()
```
    Returns:
    
    The rule 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()
```