Package com.fasterxml.jackson.datatype.jsr310

Enum JavaTimeFeature

    • 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).
      USE_TIME_ZONE_FOR_LENIENT_DATE_PARSING
      Feature that determines whether the TimeZone of the DeserializationContext is used when leniently deserializing LocalDate or LocalDateTime from the UTC/ISO instant format.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean enabledByDefault()
      Accessor for checking whether this feature is enabled by default.
      boolean enabledIn​(int flags)
      Convenience method for checking whether feature is enabled in given bitmask.
      int getMask()
      Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.
      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

        compareTo, equals, 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.

      • USE_TIME_ZONE_FOR_LENIENT_DATE_PARSING

        public static final JavaTimeFeature USE_TIME_ZONE_FOR_LENIENT_DATE_PARSING
        Feature that determines whether the TimeZone of the DeserializationContext is used when leniently deserializing LocalDate or LocalDateTime from the UTC/ISO instant format.

        Default setting is disabled, for backwards-compatibility with Jackson 2.18.

        Since:
        2.19

      • 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.

    • 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()
        Description copied from interface: JacksonFeature
        Accessor for checking whether this feature is enabled by default.
        Specified by:
        enabledByDefault in interface JacksonFeature
        Returns:
        Whether this instance is enabled by default or not

      • enabledIn

        public boolean enabledIn​(int flags)
        Description copied from interface: JacksonFeature
        Convenience method for checking whether feature is enabled in given bitmask.
        Specified by:
        enabledIn in interface JacksonFeature
        Parameters:
        flags - Bit field that contains a set of enabled features of this type
        Returns:
        True if this feature is enabled in passed bit field

      • getMask

        public int getMask()
        Description copied from interface: JacksonFeature
        Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.
        Specified by:
        getMask in interface JacksonFeature
        Returns:
        Bit mask of this feature