Allow formatting of any object type

To be able to use the `GenerationOptions` formatting
in custom placeholders for resolving single classes,
an additional `tryToFormat` method is added, which
can be used to format any type.

build.gradle

@@ -8,7 +8,7 @@ plugins {
 }
 
 group 'com.docutools'
-version = '1.4.0-alpha.30'
+version = '1.4.0-alpha.31'
 
 sourceCompatibility = "17"
 targetCompatibility = "17"

src/main/java/com/docutools/jocument/GenerationOptions.java

@@ -18,17 +18,46 @@ public record GenerationOptions(ImageStrategy imageStrategy,
                                 List<PlaceholderDataFormattingOption> formattingOptions,
                                 BiFunction<String, Locale, Optional<String>> translationFunction) {
 
+  /**
+   * Try to format a {@link PlaceholderData} with the given {@link Locale}.
+   *
+   * @param locale          The locale to use for formatting
+   * @param placeholderData The data to format
+   * @return An {@link Optional} containing the formatted {@link PlaceholderData} if successful, {@link Optional#empty()} otherwise.
+   */
   public Optional<PlaceholderData> tryToFormat(Locale locale, PlaceholderData placeholderData) {
     return formattingOptions.stream()
         .filter(option -> option.filter().accepts(placeholderData.getRawValue()))
-        .findAny()
+        .findFirst()
         .map(option -> option.formatter().format(locale, placeholderData.getRawValue()))
         .map(ScalarPlaceholderData::new);
 
   }
 
+  /**
+   * Try to format an object with the given {@link Locale}.
+   *
+   * @param locale   The locale to use for formatting
+   * @param toFormat The data to format
+   * @return An {@link Optional} containing the formatted {@link String} if successful, {@link Optional#empty()} otherwise.
+   */
+  public <T> Optional<String> tryToFormat(Locale locale, T toFormat) {
+    return formattingOptions.stream()
+        .filter(option -> option.filter().accepts(toFormat))
+        .findFirst()
+        .map(option -> option.formatter().format(locale, toFormat));
+
+  }
+
+  /**
+   * Translate a given term to the given locale.
+   *
+   * @param term   The term to translate
+   * @param locale The locale to translate the term to
+   * @return An {@link Optional} containing the translated term if successful, {@link Optional#empty()} otherwise
+   */
   public Optional<String> translate(String term, Locale locale) {
-    if(translationFunction != null) {
+    if (translationFunction != null) {
       return translationFunction.apply(term, locale);
     }
     return Optional.empty();

src/test/java/com/docutools/jocument/localisation/Formatting.java

@@ -2,17 +2,24 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.matchesPattern;
 
 import com.docutools.jocument.GenerationOptionsBuilder;
 import com.docutools.jocument.impl.ReflectionResolver;
 import com.docutools.jocument.sample.model.SampleModelData;
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;
+import java.util.Locale;
+import java.util.Optional;
+import java.util.regex.Pattern;
 import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 
 @DisplayName("Formatting")
-class Formatting {
+@Tag("automated")
+class FormattingTests {
 
   @Test
   @DisplayName("Register custom formatting for temporal types.")
@@ -35,4 +42,19 @@ void registerCustomFormatterForTemporalTypes() {
     assertThat(actual, equalTo(expected));
   }
 
+  @Test
+  void formatObjects() {
+    // Arrange
+    var dtf = DateTimeFormatter.ofPattern("dd.MM.yyyy");
+    var options = new GenerationOptionsBuilder()
+        .format(LocalDate.class, dtf::format)
+        .build();
+
+    // Act
+    Optional<String> formattedDate = options.tryToFormat(Locale.ENGLISH, LocalDate.now());
+
+    // Assert
+    assertThat(formattedDate.isPresent(), is(true));
+    assertThat(formattedDate.get(), matchesPattern(Pattern.compile("\\d\\d\\.\\d\\d\\.\\d\\d\\d\\d")));
+  }
 }