Skip to content

Rename unclear variables and private helpers in HexDump - #920

Open
sofialuiza15 wants to merge 1 commit into
apache:masterfrom
code-smells-refatoracao-grupo1:fix-bad-name-hexdump
Open

sofialuiza15 wants to merge 1 commit into
apache:masterfrom
code-smells-refatoracao-grupo1:fix-bad-name-hexdump

Conversation

@sofialuiza15

Copy link
Copy Markdown

Improves naming in HexDump.dump(byte[], long, Appendable, int, int) and its private helpers. No behavior or public API change.

  • chars_read -> bytesInLine (it counts bytes, nothing is "read" there)
  • display_offset -> displayOffset (snake_case -> camelCase, as in the rest of the project)
  • j -> lineStart, k -> column
  • private dump(StringBuilder, byte) / dump(StringBuilder, long) -> appendHex(...), since they only append hex digits and shared a name with the public dump methods
  • j -> digit in the helpers
  • Javadoc of the helpers updated: appendHex(StringBuilder, long) now says it writes only the 32 least significant bits, which is what the code does.

Refactoring: Rename Variable / Rename Method. Only private members and local variables are touched, so binary compatibility is unaffected.

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
    Claude Code (Claude Sonnet 5.5) made the code change and drafted this description; I reviewed it and ran the related tests.
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
    Validated with mvn -B -ntp (Maven 3.10.0): BUILD SUCCESS.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
    Not applicable: pure refactoring with no behavioral change. Existing tests cover it and were not modified.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

Rename chars_read to bytesInLine, display_offset to displayOffset, j to lineStart/digit and k to column. Rename the private dump(StringBuilder, byte|long) helpers to appendHex, since they only append hex digits. Update their Javadoc to state that the long variant writes only the 32 least significant bits. No behavior or public API change.

Assisted-By: Claude Sonnet 5.5
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