RuleViolationResolution 6.1.0 API

All Implemented Interfaces:
```
public final class RuleViolationResolution

                    
```
Defines the resolution of a RuleViolation. This can be used to silence rule violations that have been identified as not being relevant or are acceptable / approved.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`message`
`private final RuleViolationResolutionReason`	`reason`
`private final String`	`comment`

Constructor Summary

Constructors
Constructor	Description
`RuleViolationResolution(String message, RuleViolationResolutionReason reason, String comment)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getMessage()`	A regular expression string to match the messages of rule violations to resolve.
`final RuleViolationResolutionReason`	`getReason()`	The reason why the rule violation is resolved.
`final String`	`getComment()`	A comment to further explain why the reason is applicable here.
`final Boolean`	`matches(RuleViolation violation)`	True if message matches the message of the violation.

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

- Constructor Detail
  - RuleViolationResolution
```
RuleViolationResolution(String message, RuleViolationResolutionReason reason, String comment)
```
- Method Detail
  - getMessage
```
 final String getMessage()
```
    A regular expression string to match the messages of rule violations to resolve. Whitespace in the message will be collapsed and it will be converted to a Regex using RegexOption.DOT_MATCHES_ALL.
  - getReason
```
 final RuleViolationResolutionReason getReason()
```
    The reason why the rule violation is resolved.
  - getComment
```
 final String getComment()
```
    A comment to further explain why the reason is applicable here.
  - matches
```
 final Boolean matches(RuleViolation violation)
```
    True if message matches the message of the violation. Whitespace in the message of the violation is collapsed before matching.