Refactor Options as Selection

[deluxe]

Address #1883 by creating a whole new Selection class

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 93.75000% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.59%. Comparing base (4455309) to head (4b87498).

Files with missing lines	Patch %	Lines
...ain/java/net/datafaker/providers/base/Options.java	46.66%	8 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1885      +/-   ##
============================================
+ Coverage     92.55%   92.59%   +0.04%     
- Complexity     3562     3573      +11     
============================================
  Files           346      347       +1     
  Lines          7053     7051       -2     
  Branches        678      675       -3     
============================================
+ Hits           6528     6529       +1     
  Misses          364      364              
+ Partials        161      158       -3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[deluxe]

I first renamed subset as manyOf but settled for setOf to keep the Set reference.

[deluxe]

I also chose to deprecate random().nextEnum(Enum) to direct users to selection().oneOf(Enum) and help selection discoverability.

With this much of a change, i did not mark any class or method as forRemoval.

[asolntsev]

If we all like the name faker.selection().oneOf(...), then this PR is totally fine.

[bodiam]

Should this have the forRemoval=true flag on it? And possibly on a few other spots as well?

[bodiam]

I left a tiny comment, not 100% sure about it, but I'd think it would make sense to mark it for removal?

[deluxe]

I left a tiny comment, not 100% sure about it, but I'd think it would make sense to mark it for removal?

I'm ok with it. Will do.

[bodiam]

Thanks! Looks good to me. Anyone else feedback?

[kingthorin]

Instead of suppressing the removal warning why don't we just actually use selection internally?

[deluxe]

Because it will not return the same class (and Selection.class does not extend Options.class).

[kingthorin]

Right okay, sorry. Coffee needed 🙄

[deluxe]

Is there something left for me to do for this PR?