Update documentation

ethlo · Feb 10, 2024 · 83b77f3 · 83b77f3
1 parent a0061c0
commit 83b77f3
Show file tree

Hide file tree

Showing 10 changed files with 416 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,6 @@ Parses a date-time with flexible granularity. Works for anything from a year to
 final String text = "2012-12-27T19:07:23.123";
 final DateTime dateTime = ITU.parseLenient(text);
 final String formatted = dateTime.toString();
-//Note the tracking of fractional resolution
 assertThat(formatted).isEqualTo(text);
 ```
 
@@ -76,7 +75,9 @@ assertThat(formatted).isEqualTo(text);
 In case you encounter the need for a somewhat different time-separator or fraction separator
  you can use the `ParseConfig` to set up you preferred delimiters.
 ```java
-final ParseConfig config = ParseConfig.DEFAULT.withDateTimeSeparators('T', '|').withFractionSeparators('.', ',');
+final ParseConfig config = ParseConfig.DEFAULT
+                .withDateTimeSeparators('T', '|')
+                .withFractionSeparators('.', ',');
 final DateTime result = ITU.parseLenient("1999-11-22|11:22:17,191", config);
 assertThat(result.toString()).isEqualTo("1999-11-22T11:22:17.191");
 ```
@@ -97,18 +98,20 @@ assertThat(pos.getIndex()).isEqualTo(35);
 
 This is useful if you need to handle different granularity with different logic or interpolation.
 ```java
-final TemporalHandler<OffsetDateTime> handler = new TemporalHandler<OffsetDateTime>() {
-
-    @Override
-    public OffsetDateTime handle(final LocalDate localDate) {
-        return localDate.atTime(OffsetTime.of(LocalTime.of(0, 0), ZoneOffset.UTC));
-    }
-
-    @Override
-    public OffsetDateTime handle(final OffsetDateTime offsetDateTime) {
-        return offsetDateTime;
-    }
-};
+final TemporalHandler<OffsetDateTime> handler = new TemporalHandler<OffsetDateTime>()
+        {
+            @Override
+            public OffsetDateTime handle(final LocalDate localDate)
+            {
+                return localDate.atTime(OffsetTime.of(LocalTime.of(0, 0), ZoneOffset.UTC));
+            }
+
+            @Override
+            public OffsetDateTime handle(final OffsetDateTime offsetDateTime)
+            {
+                return offsetDateTime;
+            }
+        };
 final OffsetDateTime result = ITU.parse("2017-12-06", handler);
 assertThat(result.toString()).isEqualTo("2017-12-06T00:00Z");
 ```
@@ -129,7 +132,19 @@ assertThat(instant.toString()).isEqualTo("2017-12-06T00:00:00Z");
 
 In case the format is not supported directly, you can build your own parser.
 ```java
-final DateTimeParser parser = DateTimeParsers.of(digits(DAY, 2), separators('-'), digits(MONTH, 2), separators('-'), digits(YEAR, 4), separators(' '), digits(HOUR, 2), digits(MINUTE, 2), digits(SECOND, 2), separators(','), fractions());
+final DateTimeParser parser = DateTimeParsers.of(
+                digits(DAY, 2),
+                separators('-'),
+                digits(MONTH, 2),
+                separators('-'),
+                digits(YEAR, 4),
+                separators(' '),
+                digits(HOUR, 2),
+                digits(MINUTE, 2),
+                digits(SECOND, 2),
+                separators(','),
+                fractions()
+        );
 final String text = "31-12-2000 235937,123456";
 final DateTime result = parser.parse(text);
 assertThat(result.toString()).isEqualTo("2000-12-31T23:59:37.123456");
@@ -211,14 +226,17 @@ assertThat(input.toString(Field.SECOND)).isEqualTo("2020-11-27T12:39:19");
 
 Parse a valid leap-second (i.e. it is on a date that would allow for it, and it is also in the list of known actual leap-seconds).
 ```java
-try {
-    ITU.parseDateTime("1990-12-31T15:59:60-08:00");
-} catch (LeapSecondException exc) {
-    // The following helper methods are available let you decide how to progress
-    assertThat(exc.getSecondsInMinute()).isEqualTo(60);
-    assertThat(exc.getNearestDateTime()).isEqualTo(OffsetDateTime.of(1991, 12, 31, 1, 0, 0, 0, ZoneOffset.UTC));
-    assertThat(exc.isVerifiedValidLeapYearMonth()).isTrue();
-}
+try
+        {
+            ITU.parseDateTime("1990-12-31T15:59:60-08:00");
+        }
+        catch (LeapSecondException exc)
+        {
+            // The following helper methods are available let you decide how to progress
+            assertThat(exc.getSecondsInMinute()).isEqualTo(60);
+            assertThat(exc.getNearestDateTime()).isEqualTo(OffsetDateTime.of(1990, 12, 31, 16, 0, 0, 0, ZoneOffset.ofHours(-8)));
+            assertThat(exc.isVerifiedValidLeapYearMonth()).isTrue();
+        }
 ```