com.fasterxml.jackson.dataformat.yaml

Enum YAMLParser.Feature

java.lang.Object

java.lang.Enum<YAMLParser.Feature>

com.fasterxml.jackson.dataformat.yaml.YAMLParser.Feature

All Implemented Interfaces:

com.fasterxml.jackson.core.FormatFeature, com.fasterxml.jackson.core.util.JacksonFeature, Serializable, Comparable<YAMLParser.Feature>

Enclosing class:

YAMLParser

public static enum YAMLParser.Feature
extends Enum<YAMLParser.Feature>
implements com.fasterxml.jackson.core.FormatFeature

Enumeration that defines all togglable features for YAML parsers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY_DOCUMENT_AS_EMPTY_OBJECT Feature that determines whether empty YAML documents (documents with only comments or whitespace, or completely empty) should be exposed as empty Object (START_OBJECT/END_OBJECT token pair) instead of causing "No content to map" error.
EMPTY_STRING_AS_NULL Feature that determines whether an empty String will be parsed as null.
PARSE_BOOLEAN_LIKE_WORDS_AS_STRINGS Feature that determines whether to parse boolean-like words as strings instead of booleans.

Method Summary

Modifier and Type	Method and Description
static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
boolean	enabledIn(int flags)
int	getMask()
static YAMLParser.Feature	valueOf(String name) Returns the enum constant of this type with the specified name.
static YAMLParser.Feature[]	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

EMPTY_DOCUMENT_AS_EMPTY_OBJECT

public static final YAMLParser.Feature EMPTY_DOCUMENT_AS_EMPTY_OBJECT

Feature that determines whether empty YAML documents (documents with only comments or whitespace, or completely empty) should be exposed as empty Object (START_OBJECT/END_OBJECT token pair) instead of causing "No content to map" error.

This is useful for example for deserializing to POJOs with default values, where an empty configuration file should create an object with all default values rather than failing.

Feature is disabled by default for backwards-compatibility.

Since:

2.21

EMPTY_STRING_AS_NULL

public static final YAMLParser.Feature EMPTY_STRING_AS_NULL

Feature that determines whether an empty String will be parsed as null. Logic is part of YAML 1.1 Null Language-Independent Type.

Feature is enabled by default in Jackson 2.12 for backwards-compatibility reasons.

PARSE_BOOLEAN_LIKE_WORDS_AS_STRINGS

public static final YAMLParser.Feature PARSE_BOOLEAN_LIKE_WORDS_AS_STRINGS

Feature that determines whether to parse boolean-like words as strings instead of booleans. When enabled, the following words will be parsed as strings instead of booleans: yes, no, on, off.

Feature is disabled by default for backwards-compatibility: works the same as YAML specification default and previous Jackson versions.

Since:

2.15

Method Detail

values

public static YAMLParser.Feature[] 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 (YAMLParser.Feature c : YAMLParser.Feature.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static YAMLParser.Feature valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

collectDefaults

public static int collectDefaults()

Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface com.fasterxml.jackson.core.FormatFeature

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

Specified by:

enabledIn in interface com.fasterxml.jackson.core.util.JacksonFeature

getMask

public int getMask()

Specified by:

getMask in interface com.fasterxml.jackson.core.FormatFeature

Specified by:

getMask in interface com.fasterxml.jackson.core.util.JacksonFeature