Enum JavaTimeFeature

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.util.JacksonFeature, java.io.Serializable, java.lang.Comparable<JavaTimeFeature>

    public enum JavaTimeFeature
    extends java.lang.Enum<JavaTimeFeature>
    implements com.fasterxml.jackson.core.util.JacksonFeature
    Configurable on/off features for Java 8 Date/Time module (JavaTimeModule).
    Since:
    2.16
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS_ALLOW_STRINGIFIED_DATE_TIMESTAMPS
      Feature that controls whether stringified numbers (Strings that without quotes would be legal JSON Numbers) may be interpreted as timestamps (enabled) or not (disabled), in case where there is an explicitly defined pattern (DateTimeFormatter) for value.
      NORMALIZE_DESERIALIZED_ZONE_ID
      Feature that determines whether ZoneId is normalized (via call to java.time.ZoneId#normalized()) when deserializing types like ZonedDateTime.
      ONE_BASED_MONTHS
      Feature that determines whether Month is serialized and deserialized as using a zero-based index (FALSE) or a one-based index (TRUE).
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean _defaultState
      Whether feature is enabled or disabled by default.
      private int _mask  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private JavaTimeFeature​(boolean enabledByDefault)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean enabledByDefault()  
      boolean enabledIn​(int flags)  
      int getMask()  
      static JavaTimeFeature valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JavaTimeFeature[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NORMALIZE_DESERIALIZED_ZONE_ID

        public static final JavaTimeFeature NORMALIZE_DESERIALIZED_ZONE_ID
        Feature that determines whether ZoneId is normalized (via call to java.time.ZoneId#normalized()) when deserializing types like ZonedDateTime.

        Default setting is enabled, for backwards-compatibility with Jackson 2.15.

      • ALWAYS_ALLOW_STRINGIFIED_DATE_TIMESTAMPS

        public static final JavaTimeFeature ALWAYS_ALLOW_STRINGIFIED_DATE_TIMESTAMPS
        Feature that controls whether stringified numbers (Strings that without quotes would be legal JSON Numbers) may be interpreted as timestamps (enabled) or not (disabled), in case where there is an explicitly defined pattern (DateTimeFormatter) for value.

        Note that when the default pattern is used (no custom pattern defined), stringified numbers are always accepted as timestamps regardless of this feature.

      • ONE_BASED_MONTHS

        public static final JavaTimeFeature ONE_BASED_MONTHS
        Feature that determines whether Month is serialized and deserialized as using a zero-based index (FALSE) or a one-based index (TRUE). For example, "1" would be serialized/deserialized as Month.JANUARY if TRUE and Month.FEBRUARY if FALSE.

        Default setting is false, meaning that Month is serialized/deserialized as a zero-based index.

    • Field Detail

      • _defaultState

        private final boolean _defaultState
        Whether feature is enabled or disabled by default.
      • _mask

        private final int _mask
    • Constructor Detail

      • JavaTimeFeature

        private JavaTimeFeature​(boolean enabledByDefault)
    • Method Detail

      • values

        public static JavaTimeFeature[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (JavaTimeFeature c : JavaTimeFeature.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static JavaTimeFeature valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • enabledByDefault

        public boolean enabledByDefault()
        Specified by:
        enabledByDefault in interface com.fasterxml.jackson.core.util.JacksonFeature
      • enabledIn

        public boolean enabledIn​(int flags)
        Specified by:
        enabledIn in interface com.fasterxml.jackson.core.util.JacksonFeature
      • getMask

        public int getMask()
        Specified by:
        getMask in interface com.fasterxml.jackson.core.util.JacksonFeature