@UtilityClass -- should be non-experimental! But JavaDoc?

[Morten Sabroe Mortensen]

I am extremely found of @UtilityClass. It does have value, class being marked as final, private constructor generated. There is no doubt that it has value. None whatsoever.

However, there are two issues:

1) Instead of actively marking elements, methods as static it is better to verify it and reject the existence of non-static elements. It is best to keep the keyword "static" for plain understanding.

2) JavaDoc, in general, I hope it is not specific to my setup alone, but the class is not marked "final", the constructor is public, and there is no trace of the annotation, which I guess is okay. Is it possible to have the JavaDoc tool run on the generated code?

Regards,
Morten Sabroe Mortensen

[Jens Bannmann]

1) In my code bases, I established the convention of explicitly adding `static` to all members of @UtilityClass classes, but for a different reason: without that, the methods would not be usable with `import static`.

To help enforce conventions around @UtilityClass members being static or not, I wrote the a set of rules for my light-weight static code analysis tool mandor:

• UtilityClassMemberInconsistentlyStatic
  members should be declared consistently static / not static (i.e. within every @UtilityClass, either all members have the `static` keyword, or none)
  
  
• UtilityClassMemberMarkedStatic
  members should not be declared static as it is redundant
  
  
• UtilityClassMemberWithoutStaticModifier
  members should be explicitly declared static to make them usable in static imports

Obviously, the rules are mutually exclusive. Projects should pick one and add it to their unit tests. Here's an example how to run the third rule:

public class ExampleMandorTest
{
    @Test
    public void testRule()
    {
        new SourceBundle().importSources("src/main/java")
            .importSources("src/test/java")
            .verifyStrictly(new UtilityClassMemberWithoutStaticModifier());
    }
}

For a project with 48K lines of code, this takes only about 3 seconds on my machine.