org.junitpioneer.jupiter.params.RangeClass should be package-private

[Marcono1234]

It appears org.junitpioneer.jupiter.params.RangeClass is only used internally as meta-annotation, however currently it is public.

This leads to the inconvenient situation where RangeClass refers to the internal Range, which might be confusing for users, see:
https://javadoc.io/doc/org.junit-pioneer/junit-pioneer/latest/org/junitpioneer/jupiter/params/RangeClass.html

Therefore the annotation type should probably be made package-private and its @Documented annotation should be removed.

A similar issue exists for org.junitpioneer.jupiter.params.RangeSourceArgumentsProvider which is visible through the documented annotation ArgumentsSource on the NumericTypeRangeSource classes (e.g. ShortRangeSource). However, there it cannot be easily solved without making RangeSourceArgumentsProvider public, which might not be desired, so maybe there this broken reference is acceptable.

[Michael1993]

If I remember correctly, it's public so people can make their own range sources. Does the documentation have anything on that? 🤔

[Marcono1234]

The documentation does not seem to mention that, and in its current form users cannot create their own range sources because neither RangeSourceArgumentsProvider nor Range or its subclasses are public.

[Michael1993]

I recently did a review of our classes and it seems some of them were unnecessarily public instead of package-private... This is probably the case with RangeClass as well. It has some Javadoc and that kind of threw me off. 😓

[nipafx]

Thank for pointing this out, @Marcono1234. This was indeed an implementation-only class.

Re NumericTypeRangeSource ~> ArgumentsSource ~> RangeSourceArgumentsProvider: It will usually be the case that an annotation is public but the extension class implementing its behavior (linked via public annotations like @ExtendWith, @ArgumentsSource, or something like @RangeClass) is not.