Add documentation for TomlReadFeature#PARSE_JAVA_TIME

FasterXML · Apr 10, 2021 · 776690f · 776690f
1 parent b6d626d
commit 776690f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/toml/src/main/java/com/fasterxml/jackson/dataformat/toml/TomlReadFeature.java b/toml/src/main/java/com/fasterxml/jackson/dataformat/toml/TomlReadFeature.java
@@ -7,6 +7,14 @@
  */
 public enum TomlReadFeature
         implements FormatFeature {
+    /**
+     * TOML has special syntax for time types corresponding to {@link java.time.LocalDate}, {@link java.time.LocalTime},
+     * {@link java.time.LocalDateTime} and {@link java.time.OffsetDateTime}. By default, the TOML parser just returns
+     * them as strings.
+     * <p>
+     * When this option is set, these time types will be parsed to their proper {@code java.time} counterparts and
+     * appear as {@link com.fasterxml.jackson.core.JsonToken#VALUE_EMBEDDED_OBJECT} tokens.
+     */
     PARSE_JAVA_TIME(false);
 
     final boolean _defaultState;