Files that changed from the base of the PR and between 4e01634 and 2888040.

• src/main/java/org/threeten/extra/AmountFormats.java (3 hunks)
• src/test/java/org/threeten/extra/TestAmountFormats.java (2 hunks)

src/main/java/org/threeten/extra/AmountFormats.java (3)

Line range hint 1-863: Overall assessment of changes to AmountFormats.java

The changes to this file enhance the flexibility and customization options of the AmountFormats class. The new wordBasedWithFormats method and the increased visibility of constants provide users with more control over formatting options. The implementation is consistent with the existing codebase and follows good coding practices.

Some minor improvements have been suggested, such as additional validation for the new method. It's also important to consider the long-term implications of making the constants public.

Please ensure that these changes are well-documented in the class and module level documentation, and that any public API changes are reflected in the project's changelog or release notes.

---

302-363: New method provides flexible word-based formatting

The new wordBasedWithFormats method enhances the class's functionality by allowing custom formatting of time units. This addition aligns well with the class's purpose and provides users with more control over the output format.

Some observations and suggestions:

1. Null checks and validation:
   The method properly checks for null parameters, which is good practice. Consider adding validation for the formats list to ensure it's not empty.

2. Time unit calculations:
   The logic for calculating weeks and days is consistent with other methods in the class, which maintains coherence in the codebase.

3. Use of streams:
   The method uses streams and functional programming concepts, which is modern and concise. However, for very large lists of formats, this might have a slight performance impact. Consider benchmarking with large format lists to ensure performance meets expectations.

4. Consistency:
   The method follows the pattern of other wordBased methods in the class, which is good for maintainability and understanding.

5. Reusability:
   The method reuses the WordBased class, promoting code reuse and consistency.

Consider adding a check for an empty formats list:

 public static String wordBasedWithFormats(Period period, Duration duration, List<String> formats, Locale locale) {
     Objects.requireNonNull(period, "period must not be null");
     Objects.requireNonNull(duration, "duration must not be null");
     Objects.requireNonNull(formats, "formats must not be null");
+    if (formats.isEmpty()) {
+        throw new IllegalArgumentException("formats list must not be empty");
+    }
     Objects.requireNonNull(locale, "locale must not be null");
     // ... rest of the method
 }

To ensure the new method is properly integrated and doesn't introduce any regressions, run the following script:

#!/bin/bash
# Check for usage of the new method and potential test coverage
rg --type java "wordBasedWithFormats" -g '!AmountFormats.java'

---

95-123: Consider the implications of changing constant visibility.

The visibility of several constants (WORDBASED_YEAR, WORDBASED_MONTH, etc.) has been changed from private to public. While this allows for external use and customization, it may impact encapsulation and make future modifications more challenging. Ensure that this change aligns with the library's design principles and future maintainability goals.

To verify the usage of these constants, run the following script:

src/test/java/org/threeten/extra/TestAmountFormats.java (3)

40-41: LGTM: New imports added for Arrays and List.

These imports are necessary for the new test methods that use lists of format strings in the wordBasedWithFormats functionality.

---

188-192: LGTM: New test method added for wordBasedWithFormats functionality.

The test_wordBasedWithFormats method is a well-structured parameterized test that uses the new data provider to test the AmountFormats.wordBasedWithFormats method with various inputs. This ensures comprehensive testing of the new functionality.

---

Line range hint 40-193: Overall assessment: Comprehensive test coverage for new functionality.

The changes in this file significantly enhance the test suite for the AmountFormats class by adding support for the new wordBasedWithFormats functionality. The additions include:

1. New imports for Arrays and List.
2. A new data provider method period_duration_wordBasedWithFormats() with various test cases.
3. A new parameterized test method test_wordBasedWithFormats.

These changes ensure thorough testing of the new feature across different scenarios, time units, and locales. The code style and structure are consistent with the existing codebase, maintaining good readability and maintainability.

To ensure that the new wordBasedWithFormats method is properly implemented in the AmountFormats class, please run the following command: