Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving XMLCodec constants to their own classes #531

Merged
merged 3 commits into from
Aug 18, 2023

Conversation

sambish5
Copy link
Collaborator

@sambish5 sambish5 commented Aug 4, 2023

#515 (comment)
Done from this comment left on 515. Moved AnswerFile constants and method constants to separate classes.

Copy link
Collaborator

@jdcove2 jdcove2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions...

  • "AsnwerXMLFileElementNames" -> "IbdoXmlElementNames"
  • "IBDOMethodNames" -> "IbdoMethodNames"
  • Javadoc all of the constants in the above classes.
  • Make the above two classes final.
  • Move ...ATTRIBUTE_NAME fields to IbdoXmlElementNames class.

@drivenflywheel
Copy link
Collaborator

Some suggestions...

  • "AsnwerXMLFileElementNames" -> "IbdoXmlElementNames"
    Disagree on this one. IBDOs don't have element names, and these names are specific to our UnitTest/ExtractionTest/RegressionTest XML answer files.
  • "IBDOMethodNames" -> "IbdoMethodNames"
    Meh, I find IBDOMethodNames to be more readable
  • Javadoc all of the constants in the above classes.
    IMO, constants should only have Javadoc comments if those comments clarify usage or ambiguity.
  • Make the above two classes final.
  • Move ...ATTRIBUTE_NAME fields to IbdoXmlElementNames class.

Copy link
Collaborator

@drivenflywheel drivenflywheel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good first pass, but I think we can further improve the readability with minimal effort.

@cfkoehler cfkoehler added this to the v8.0.0-M3 milestone Aug 17, 2023
@jpdahlke jpdahlke merged commit 1bfb66e into NationalSecurityAgency:master Aug 18, 2023
9 checks passed
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.

5 participants