Class YAMLFactoryBuilder
TSFBuilder
implementation for constructing YAMLFactory
instances.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.yaml.snakeyaml.DumperOptions
Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).protected int
Set ofYAMLGenerator.Feature
s enabled, as bitmask.protected int
Set ofYAMLParser.Feature
s enabled, as bitmask.protected org.yaml.snakeyaml.LoaderOptions
Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).protected StringQuotingChecker
Helper object used to determine whether property names, String values must be quoted or not.protected org.yaml.snakeyaml.DumperOptions.Version
YAML version for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).Fields inherited from class com.fasterxml.jackson.core.TSFBuilder
_factoryFeatures, _inputDecorator, _outputDecorator, _streamReadConstraints, _streamReadFeatures, _streamWriteFeatures, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
configure
(YAMLGenerator.Feature f, boolean state) configure
(YAMLParser.Feature f, boolean state) disable
(YAMLGenerator.Feature first, YAMLGenerator.Feature... other) disable
(YAMLParser.Feature first, YAMLParser.Feature... other) org.yaml.snakeyaml.DumperOptions
Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).dumperOptions
(org.yaml.snakeyaml.DumperOptions dumperOptions) Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).enable
(YAMLGenerator.Feature first, YAMLGenerator.Feature... other) enable
(YAMLParser.Feature first, YAMLParser.Feature... other) int
int
org.yaml.snakeyaml.LoaderOptions
Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).loaderOptions
(org.yaml.snakeyaml.LoaderOptions loaderOptions) Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).Method for specifying either customStringQuotingChecker
to use instead of default one, or, that default one (seeStringQuotingChecker.Default.instance()
) is to be used (when passingnull
org.yaml.snakeyaml.DumperOptions.Version
yamlVersionToWrite
(org.yaml.snakeyaml.DumperOptions.Version v) Method for specifying YAML version for generator to use (to produce compliant output); ifnull
passed, will letSnakeYAML
use its default settings.Methods inherited from class com.fasterxml.jackson.core.TSFBuilder
_legacyDisable, _legacyDisable, _legacyEnable, _legacyEnable, _this, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, enable, enable, enable, factoryFeaturesMask, inputDecorator, inputDecorator, outputDecorator, outputDecorator, streamReadConstraints, streamReadFeatures, streamWriteFeatures
-
Field Details
-
_formatGeneratorFeatures
protected int _formatGeneratorFeaturesSet ofYAMLGenerator.Feature
s enabled, as bitmask. -
_formatParserFeatures
protected int _formatParserFeaturesSet ofYAMLParser.Feature
s enabled, as bitmask.- Since:
- 2.15
-
_quotingChecker
Helper object used to determine whether property names, String values must be quoted or not.- Since:
- 2.12
-
_version
protected org.yaml.snakeyaml.DumperOptions.Version _versionYAML version for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).Ignored if you provide your own
DumperOptions
. -
_loaderOptions
protected org.yaml.snakeyaml.LoaderOptions _loaderOptionsConfiguration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).If you need to support parsing YAML files that are larger than 3Mb, it is recommended that you provide a LoaderOptions instance where you set the Codepoint Limit to a larger value than its 3Mb default.
- Since:
- 2.14
-
_dumperOptions
protected org.yaml.snakeyaml.DumperOptions _dumperOptionsConfiguration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).These
YAMLGenerator.Feature
s are ignored if you provide your own DumperOptions:YAMLGenerator.Feature.ALLOW_LONG_KEYS
YAMLGenerator.Feature.CANONICAL_OUTPUT
YAMLGenerator.Feature.INDENT_ARRAYS
YAMLGenerator.Feature.INDENT_ARRAYS_WITH_INDICATOR
YAMLGenerator.Feature.SPLIT_LINES
YAMLGenerator.Feature.USE_PLATFORM_LINE_BREAKS
- Since:
- 2.14
-
-
Constructor Details
-
YAMLFactoryBuilder
protected YAMLFactoryBuilder() -
YAMLFactoryBuilder
-
-
Method Details
-
enable
-
enable
-
disable
-
disable
-
configure
-
enable
-
enable
-
disable
-
disable
-
configure
-
stringQuotingChecker
Method for specifying either customStringQuotingChecker
to use instead of default one, or, that default one (seeStringQuotingChecker.Default.instance()
) is to be used (when passingnull
- Parameters:
sqc
- Checker to use (if non-null), ornull
to use the default one (seeStringQuotingChecker.Default.instance()
)- Returns:
- This builder instance, to allow chaining
-
yamlVersionToWrite
Method for specifying YAML version for generator to use (to produce compliant output); ifnull
passed, will letSnakeYAML
use its default settings.- Parameters:
v
- YAML specification version to use for output, if not-null;null
for default handling- Returns:
- This builder instance, to allow chaining
-
loaderOptions
Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).If you need to support parsing YAML files that are larger than 3Mb, it is recommended that you provide a LoaderOptions instance where you set the Codepoint Limit to a larger value than its 3Mb default.
- Parameters:
loaderOptions
- theSnakeYAML
configuration to use when parsing YAML- Returns:
- This builder instance, to allow chaining
- Since:
- 2.14
-
dumperOptions
Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).These
YAMLGenerator.Feature
s are ignored if you provide your own DumperOptions:YAMLGenerator.Feature.ALLOW_LONG_KEYS
YAMLGenerator.Feature.CANONICAL_OUTPUT
YAMLGenerator.Feature.INDENT_ARRAYS
YAMLGenerator.Feature.INDENT_ARRAYS_WITH_INDICATOR
YAMLGenerator.Feature.SPLIT_LINES
YAMLGenerator.Feature.USE_PLATFORM_LINE_BREAKS
- Parameters:
dumperOptions
- theSnakeYAML
configuration to use when generating YAML- Returns:
- This builder instance, to allow chaining
- Since:
- 2.14
-
formatParserFeaturesMask
public int formatParserFeaturesMask() -
formatGeneratorFeaturesMask
public int formatGeneratorFeaturesMask() -
yamlVersionToWrite
public org.yaml.snakeyaml.DumperOptions.Version yamlVersionToWrite() -
stringQuotingChecker
-
loaderOptions
public org.yaml.snakeyaml.LoaderOptions loaderOptions()Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).If you need to support parsing YAML files that are larger than 3Mb, it is recommended that you provide a LoaderOptions instance where you set the Codepoint Limit to a larger value than its 3Mb default.
- Returns:
- the
SnakeYAML
configuration to use when parsing YAML - Since:
- 2.14
-
dumperOptions
public org.yaml.snakeyaml.DumperOptions dumperOptions()Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).These
YAMLGenerator.Feature
s are ignored if you provide your own DumperOptions:YAMLGenerator.Feature.ALLOW_LONG_KEYS
YAMLGenerator.Feature.CANONICAL_OUTPUT
YAMLGenerator.Feature.INDENT_ARRAYS
YAMLGenerator.Feature.INDENT_ARRAYS_WITH_INDICATOR
YAMLGenerator.Feature.SPLIT_LINES
YAMLGenerator.Feature.USE_PLATFORM_LINE_BREAKS
- Returns:
- the
SnakeYAML
configuration to use when generating YAML - Since:
- 2.14
-
build
- Specified by:
build
in classcom.fasterxml.jackson.core.TSFBuilder<YAMLFactory,
YAMLFactoryBuilder>
-