This PR implements three refactorings in JavacTokens.java to address several identified design smells. The changes improve code organization and maintainability while maintaining all existing functionality.
Changes Made
1. Extract Class - TokenPosition
Created dedicated class for position management
Handles pos/endPos fields and related operations
Addresses "Unnecessary Abstraction" and "Multifaceted Abstraction" smells
Main affected classes: RawTok, CommentWithTextAndPosition
2. Move Method - Position Validation
Relocated validation logic to TokenPosition class
Validates position indices where position data lives
Addresses "Multifaceted Abstraction" smell
Improves cohesion of position-related operations
3. Move Field - Position Fields
Consolidated pos/endPos fields into TokenPosition
Removed duplicate fields from multiple classes
Addresses "Leaky Encapsulation" and "Duplicate Abstraction" smells
Ensures consistent position handling
Testing
All existing tests pass successfully
No changes to public APIs
Original functionality preserved
Verified backward compatibility
Implementation Notes
No behavioral changes made
Only internal refactoring for better organization
Maintains existing interfaces and contracts
Follows project coding standards
Related Issues
Resolves#1201 - Design smells in JavacTokens class
Documentation
Maintained existing documentation style
Change Impact
Risk Level: Low
Affected Components:
JavacTokens.java
Checklist
Code follows project style guidelines
All tests pass
No new warnings introduced
Additional Notes
These refactorings improve code quality while carefully preserving all existing behavior. The changes make the codebase more maintainable and reduce the likelihood of position-related errors.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactor JavacTokens to Address Design Smells
Description
This PR implements three refactorings in JavacTokens.java to address several identified design smells. The changes improve code organization and maintainability while maintaining all existing functionality.
Changes Made
1. Extract Class - TokenPosition
2. Move Method - Position Validation
3. Move Field - Position Fields
Testing
Implementation Notes
Related Issues
Resolves #1201 - Design smells in JavacTokens class
Documentation
Change Impact
Checklist
Additional Notes
These refactorings improve code quality while carefully preserving all existing behavior. The changes make the codebase more maintainable and reduce the likelihood of position-related errors.
/cc @reviewer1 @reviewer2