Skip to content

[ISSUE-3397] Fix checkstyle violations in quickstart examples#10045

Open
paultanay wants to merge 1 commit intoapache:developfrom
paultanay:fix/issue-3397-quickstart-examples
Open

[ISSUE-3397] Fix checkstyle violations in quickstart examples#10045
paultanay wants to merge 1 commit intoapache:developfrom
paultanay:fix/issue-3397-quickstart-examples

Conversation

@paultanay
Copy link

This PR addresses part of Issue #3397 by fixing checkstyle violations in the quickstart example module. I'm starting with the most visible files (Producer.java and Consumer.java) to establish a pattern for fixing the remaining ~1315 violations across all example files.

Changes made:

Producer.java:

Extracted magic numbers to named constants with Javadoc (SEND_TIMEOUT_MILLIS, ERROR_SLEEP_MILLIS)
Added private constructor to prevent instantiation
Fixed line length violations (80 character max)
Simplified message creation code for better readability
Consumer.java:

Extracted hardcoded strings to constants (TAG_FILTER)
Added private constructor
Made method parameters final
Replaced lambda with explicit anonymous class for educational clarity
Added missing imports and comprehensive Javadoc
Fixed line length violations
This fixes approximately 30-40 checkstyle violations in these two files.

- Extracted magic numbers to named constants with Javadoc
- Added private constructors to prevent instantiation
- Fixed line length violations (80 character max)
- Replaced lambda with explicit anonymous class for clarity
- Added comprehensive Javadoc comments
- Made method parameters final
This addresses part of Issue apache#3397 by cleaning up the most
visible example files first. Fixes approximately 30-40 checkstyle
violations in Producer.java and Consumer.java.
Related to apache#3397
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant