Package com.fasterxml.jackson.databind.cfg

Enum EnumFeature

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      READ_ENUM_KEYS_USING_INDEX
      Feature that determines standard deserialization mechanism used for Enum values: if enabled, Enums are assumed to have been serialized using index of Enum;
      WRITE_ENUMS_TO_LOWERCASE
      Feature that determines standard serialization mechanism used for Enum values: if enabled, return value of Enum.name().toLowerCase() is used; if disabled, return value of Enum.name() is used.

    • 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 featureIndex()
      Internal index used for efficient storage and index; no user serviceable contents inside!
      int getMask()
      Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.
      static EnumFeature valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EnumFeature[] 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

      • READ_ENUM_KEYS_USING_INDEX

        public static final EnumFeature READ_ENUM_KEYS_USING_INDEX
        Feature that determines standard deserialization mechanism used for Enum values: if enabled, Enums are assumed to have been serialized using index of Enum;

        Note: this feature should be symmetric to as SerializationFeature.WRITE_ENUM_KEYS_USING_INDEX.

        Feature is disabled by default.

        Since:
        2.15

      • WRITE_ENUMS_TO_LOWERCASE

        public static final EnumFeature WRITE_ENUMS_TO_LOWERCASE
        Feature that determines standard serialization mechanism used for Enum values: if enabled, return value of Enum.name().toLowerCase() is used; if disabled, return value of Enum.name() is used.

        NOTE: this feature CAN NOT be changed on per-call basis: it will have to be set on ObjectMapper before use

        Feature is disabled by default.

        Since:
        2.15

    • Method Detail

      • values

        public static EnumFeature[] 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 (EnumFeature c : EnumFeature.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EnumFeature 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

      • featureIndex

        public int featureIndex()
        Description copied from interface: DatatypeFeature
        Internal index used for efficient storage and index; no user serviceable contents inside!
        Specified by:
        featureIndex in interface DatatypeFeature