YAMLGenerator.Feature (Jackson-dataformat-YAML 2.11.0 API)

java.lang.Object
- java.lang.Enum<YAMLGenerator.Feature>
- - com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature

All Implemented Interfaces:

com.fasterxml.jackson.core.FormatFeature, Serializable, Comparable<YAMLGenerator.Feature>

Enclosing class:

YAMLGenerator
```
public static enum YAMLGenerator.Feature
extends Enum<YAMLGenerator.Feature>
implements com.fasterxml.jackson.core.FormatFeature
```
Enumeration that defines all togglable features for YAML generators

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALWAYS_QUOTE_NUMBERS_AS_STRINGS` Whether numbers stored as strings will be rendered with quotes (true) or without quotes (false, default) when MINIMIZE_QUOTES is enabled.
`CANONICAL_OUTPUT` Do we try to force so-called canonical output or not.
`INDENT_ARRAYS` Feature enabling of which adds indentation for array entry generation (default indentation being 2 spaces).
`LITERAL_BLOCK_STYLE` Whether for string containing newlines a literal block style should be used.
`MINIMIZE_QUOTES` Whether strings will be rendered without quotes (true) or with quotes (false, default).
`SPLIT_LINES` Options passed to SnakeYAML that determines whether longer textual content gets automatically split into multiple lines or not.
`USE_NATIVE_OBJECT_ID` Whether to use YAML native Object Id construct for indicating type (true); or "generic" Object Id mechanism (false).
`USE_NATIVE_TYPE_ID` Whether to use YAML native Type Id construct for indicating type (true); or "generic" type property (false).
`USE_PLATFORM_LINE_BREAKS` Option passed to SnakeYAML that determines if the line breaks used for serialization should be same as what the default is for current platform.
`WRITE_DOC_START_MARKER` Whether we are to write an explicit document start marker ("---") or not.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean _defaultState

protected int _mask

Fields
Modifier and Type	Field and Description
`protected boolean`	`_defaultState`
`protected int`	`_mask`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 YAMLGenerator.Feature`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static YAMLGenerator.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
  - WRITE_DOC_START_MARKER
```
public static final YAMLGenerator.Feature WRITE_DOC_START_MARKER
```
    Whether we are to write an explicit document start marker ("---") or not.
    
    Since:
    
    2.3
  - USE_NATIVE_OBJECT_ID
```
public static final YAMLGenerator.Feature USE_NATIVE_OBJECT_ID
```
    Whether to use YAML native Object Id construct for indicating type (true); or "generic" Object Id mechanism (false). Former works better for systems that are YAML-centric; latter may be better choice for interoperability, when converting between formats or accepting other formats.
    
    Since:
    
    2.5
  - USE_NATIVE_TYPE_ID
```
public static final YAMLGenerator.Feature USE_NATIVE_TYPE_ID
```
    Whether to use YAML native Type Id construct for indicating type (true); or "generic" type property (false). Former works better for systems that are YAML-centric; latter may be better choice for interoperability, when converting between formats or accepting other formats.
    
    Since:
    
    2.5
  - CANONICAL_OUTPUT
```
public static final YAMLGenerator.Feature CANONICAL_OUTPUT
```
    Do we try to force so-called canonical output or not.
  - SPLIT_LINES
```
public static final YAMLGenerator.Feature SPLIT_LINES
```
    Options passed to SnakeYAML that determines whether longer textual content gets automatically split into multiple lines or not.
    Feature is enabled by default to conform to SnakeYAML defaults as well as backwards compatibility with 2.5 and earlier versions.
    
    Since:
    
    2.6
  - MINIMIZE_QUOTES
```
public static final YAMLGenerator.Feature MINIMIZE_QUOTES
```
    Whether strings will be rendered without quotes (true) or with quotes (false, default).
    Minimized quote usage makes for more human readable output; however, content is limited to printable characters according to the rules of literal block style.
    
    Since:
    
    2.7
  - ALWAYS_QUOTE_NUMBERS_AS_STRINGS
```
public static final YAMLGenerator.Feature ALWAYS_QUOTE_NUMBERS_AS_STRINGS
```
    Whether numbers stored as strings will be rendered with quotes (true) or without quotes (false, default) when MINIMIZE_QUOTES is enabled.
    Minimized quote usage makes for more human readable output; however, content is limited to printable characters according to the rules of literal block style.
    
    Since:
    
    2.8.2
  - LITERAL_BLOCK_STYLE
```
public static final YAMLGenerator.Feature LITERAL_BLOCK_STYLE
```
    Whether for string containing newlines a literal block style should be used. This automatically enabled when MINIMIZE_QUOTES is set.
    The content of such strings is limited to printable characters according to the rules of literal block style.
    
    Since:
    
    2.9
  - INDENT_ARRAYS
```
public static final YAMLGenerator.Feature INDENT_ARRAYS
```
    Feature enabling of which adds indentation for array entry generation (default indentation being 2 spaces).
    Default value is `false` for backwards compatibility
    
    Since:
    
    2.9
  - USE_PLATFORM_LINE_BREAKS
```
public static final YAMLGenerator.Feature USE_PLATFORM_LINE_BREAKS
```
    Option passed to SnakeYAML that determines if the line breaks used for serialization should be same as what the default is for current platform. If disabled, Unix linefeed (\n) will be used.
    Default value is `false` for backwards compatibility.
    
    Since:
    
    2.9.6
- Field Detail
  - _defaultState
```
protected final boolean _defaultState
```
  - _mask
```
protected final int _mask
```
- Method Detail
  - values
```
public static YAMLGenerator.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 (YAMLGenerator.Feature c : YAMLGenerator.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 YAMLGenerator.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
  - enabledIn
```
public boolean enabledIn(int flags)
```
    Specified by:
    
    enabledIn in interface com.fasterxml.jackson.core.FormatFeature
  - getMask
```
public int getMask()
```
    Specified by:
    
    getMask in interface com.fasterxml.jackson.core.FormatFeature

Enum YAMLGenerator.Feature

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

WRITE_DOC_START_MARKER

USE_NATIVE_OBJECT_ID

USE_NATIVE_TYPE_ID

CANONICAL_OUTPUT

SPLIT_LINES

MINIMIZE_QUOTES

ALWAYS_QUOTE_NUMBERS_AS_STRINGS

LITERAL_BLOCK_STYLE

INDENT_ARRAYS

USE_PLATFORM_LINE_BREAKS

Field Detail

_defaultState

_mask

Method Detail

values

valueOf

collectDefaults

enabledByDefault

enabledIn

getMask