[MCHECKSTYLE-385] Violation should be a value class

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.1.0
• Fix Version/s: 3.1.2
• Component/s: checkstyle:check
• Labels: easyfix pull-request-available
• Environment: Any (Linux, Window OS, etc.)
• Assignee: Benjamin Marwell
• Reporter: Benjamin Marwell
• Created: 12/Dec/19 09:50
• Updated: 05/Apr/21 20:39
• Resolved: 08/Dec/20 09:58

Description

Dear developers,

while starting to implement the feature https://issues.apache.org/jira/browse/MCHECKSTYLE-356, I found out that a refactoring is needed.

 

The method int countViolations(Parser) does so many things besides counting violations. Some of them are:

• checking, if printing violations is wanted.
• actually printing violations
• counting violations
• counting ignored violations
• checking ignored violations count > 0 and logging
• Keeping track of file changes

I would like to rework this part of the code with no functional changes by creating a "Violation" value class.

PR follows.

Issue Links

• is required by: MCHECKSTYLE-369 Sort Checkstyle Report
• is required by: MCHECKSTYLE-370 Make file names relative
• links to: GitHub Pull Request #17