Skip to content

Standardize utility class pattern #127

Closed

Description

@gselzer

In this review comment @ctrueden suggested we standardize the way we create utility classes. I'm not quite sure what he would like to standardize, but I'm going to create this issue so his desire for standardization is not lost!

Activity

  1. ctrueden commented on Sep 26, 2023

    @ctrueden
    Member

    I use a line comment inside the private constructor with a particular string, rather than a javadoc comment.

    We could also use this issue an opportunity to decide whether we are using plural (e.g. Types) or some suffix (e.g. OpUtils). We should not do both.

  2. gselzer commented on Nov 16, 2023

    @gselzer
    MemberAuthor

    Three things needed to fix this issue:

    • Private constructor with comment explaining that it is a utility class
    • Ensure standard utility class naming, preferably calling them Foos, Bars, etc.
    • Make all utility classes final

    The final thing is to get rid of the double Ops utility classes.

  3. added this to the 1.0.0 milestone on Nov 16, 2023
  4. assigned and unassigned on Nov 27, 2023
  5. added a commit that references this issue on May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions