Jackson 2.18.2 · com.fasterxml.jackson.dataformat.yaml.YAMLFactoryBuilder

Field Summary

Modifier and Type	Field and Description
protected DumperOptions	_dumperOptions Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.Feature`s).
protected int	_formatGeneratorFeatures Set of `YAMLGenerator.Feature`s enabled, as bitmask.
protected int	_formatParserFeatures Set of `YAMLParser.Feature`s enabled, as bitmask.
protected LoaderOptions	_loaderOptions Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).
protected StringQuotingChecker	_quotingChecker Helper object used to determine whether property names, String values must be quoted or not.
protected DumperOptions.Version	_version YAML version for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).

Inherited from com.fasterxml.jackson.core.TSFBuilder:: _errorReportConfiguration _factoryFeatures _generatorDecorators _inputDecorator _outputDecorator _recyclerPool _streamReadConstraints _streamReadFeatures _streamWriteConstraints _streamWriteFeatures DEFAULT_FACTORY_FEATURE_FLAGS DEFAULT_GENERATOR_FEATURE_FLAGS DEFAULT_PARSER_FEATURE_FLAGS

Constructor Summary

Access	Constructor and Description
protected	YAMLFactoryBuilder()
public	YAMLFactoryBuilder(YAMLFactory base)

Method Summary

Modifier and Type	Method and Description
public YAMLFactory	build() Implements abstract com.fasterxml.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration.
public YAMLFactoryBuilder	configure(YAMLParser.Feature f, boolean state)
public YAMLFactoryBuilder	configure(YAMLGenerator.Feature f, boolean state)
public YAMLFactoryBuilder	disable(YAMLParser.Feature f)
public YAMLFactoryBuilder	disable(YAMLParser.Feature first, YAMLParser.Feature... other)
public YAMLFactoryBuilder	disable(YAMLGenerator.Feature f)
public YAMLFactoryBuilder	disable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other)
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining dumperOptions(DumperOptions the `SnakeYAML` configuration to use when generating YAML dumperOptions) Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.Feature`s).
public DumperOptions	Returns: the `SnakeYAML` configuration to use when generating YAML dumperOptions() Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.Feature`s).
public YAMLFactoryBuilder	enable(YAMLParser.Feature f)
public YAMLFactoryBuilder	enable(YAMLParser.Feature first, YAMLParser.Feature... other)
public YAMLFactoryBuilder	enable(YAMLGenerator.Feature f)
public YAMLFactoryBuilder	enable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other)
public int	formatGeneratorFeaturesMask()
public int	formatParserFeaturesMask()
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining loaderOptions(LoaderOptions the `SnakeYAML` configuration to use when parsing YAML loaderOptions) Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).
public LoaderOptions	Returns: the `SnakeYAML` configuration to use when parsing YAML loaderOptions() Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining stringQuotingChecker(StringQuotingChecker Checker to use (if non-null), or `null` to use the default one (see `StringQuotingChecker.Default.instance()`) sqc) Method for specifying either custom `StringQuotingChecker` to use instead of default one, or, that default one (see `StringQuotingChecker.Default.instance()`) is to be used (when passing `null`
public StringQuotingChecker	stringQuotingChecker()
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining yamlVersionToWrite(DumperOptions.Version YAML specification version to use for output, if not-null; `null` for default handling v) Method for specifying YAML version for generator to use (to produce compliant output); if `null` passed, will let `SnakeYAML` use its default settings.
public DumperOptions.Version	yamlVersionToWrite()

Field Detail

_dumperOptions back to summary

_dumperOptions	back to summary
protected DumperOptions _dumperOptions Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.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

protected DumperOptions _dumperOptions

Configuration for underlying generator to follow, if specified; left as null for backwards compatibility (which means the dumper options are derived based on YAMLGenerator.Features).

These YAMLGenerator.Features 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

_formatGeneratorFeatures	back to summary
protected int _formatGeneratorFeatures Set of `YAMLGenerator.Feature`s enabled, as bitmask.

_formatParserFeatures back to summary

_formatParserFeatures	back to summary
protected int _formatParserFeatures Set of `YAMLParser.Feature`s enabled, as bitmask. Since 2.15

protected int _formatParserFeatures

Set of YAMLParser.Features enabled, as bitmask.

Since: 2.15

_loaderOptions back to summary

_loaderOptions	back to summary
protected LoaderOptions _loaderOptions Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` 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

protected LoaderOptions _loaderOptions

Configuration for underlying parser to follow, if specified; left as null for backwards compatibility (which means whatever default settings SnakeYAML 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

_quotingChecker	back to summary
protected StringQuotingChecker _quotingChecker Helper object used to determine whether property names, String values must be quoted or not. Since 2.12

_quotingChecker

back to summary

protected StringQuotingChecker _quotingChecker

Helper object used to determine whether property names, String values must be quoted or not.

Since: 2.12

_version back to summary

_version	back to summary
protected DumperOptions.Version _version YAML version for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best). Ignored if you provide your own `DumperOptions`.

protected DumperOptions.Version _version

YAML version for underlying generator to follow, if specified; left as null for backwards compatibility (which means whatever default settings SnakeYAML deems best).

Ignored if you provide your own DumperOptions.

Constructor Detail

YAMLFactoryBuilder	back to summary
protected YAMLFactoryBuilder()

YAMLFactoryBuilder	back to summary
public YAMLFactoryBuilder(YAMLFactory base)

Method Detail

build back to summary

build	back to summary
public YAMLFactory build() Implements abstract com.fasterxml.jackson.core.TSFBuilder.build. Doc from com.fasterxml.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration. Returns:YAMLFactory `TokenStreamFactory` build based on current configuration Annotations @Override

public YAMLFactory build()

Implements abstract com.fasterxml.jackson.core.TSFBuilder.build.

Doc from com.fasterxml.jackson.core.TSFBuilder.build.

Method for constructing actual TokenStreamFactory instance, given configuration.

Returns:YAMLFactory

TokenStreamFactory build based on current configuration

Annotations

@Override

configure	back to summary
public YAMLFactoryBuilder configure(YAMLParser.Feature f, boolean state)

configure	back to summary
public YAMLFactoryBuilder configure(YAMLGenerator.Feature f, boolean state)

disable	back to summary
public YAMLFactoryBuilder disable(YAMLParser.Feature f)

disable	back to summary
public YAMLFactoryBuilder disable(YAMLParser.Feature first, YAMLParser.Feature... other)

disable	back to summary
public YAMLFactoryBuilder disable(YAMLGenerator.Feature f)

disable	back to summary
public YAMLFactoryBuilder disable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other)

dumperOptions back to summary

dumperOptions	back to summary
public YAMLFactoryBuilder dumperOptions(DumperOptions dumperOptions) Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.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:DumperOptions the `SnakeYAML` configuration to use when generating YAML Returns:YAMLFactoryBuilder This builder instance, to allow chaining Since 2.14

public YAMLFactoryBuilder dumperOptions(DumperOptions dumperOptions)

Configuration for underlying generator to follow, if specified; left as null for backwards compatibility (which means the dumper options are derived based on YAMLGenerator.Features).

These YAMLGenerator.Features 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:DumperOptions: the SnakeYAML configuration to use when generating YAML

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

Since

2.14

dumperOptions back to summary

dumperOptions	back to summary
public DumperOptions dumperOptions() Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLGenerator.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:DumperOptions the `SnakeYAML` configuration to use when generating YAML Since 2.14

public DumperOptions dumperOptions()

Configuration for underlying generator to follow, if specified; left as null for backwards compatibility (which means the dumper options are derived based on YAMLGenerator.Features).

These YAMLGenerator.Features 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:DumperOptions: the SnakeYAML configuration to use when generating YAML
Since: 2.14

enable	back to summary
public YAMLFactoryBuilder enable(YAMLParser.Feature f)

enable	back to summary
public YAMLFactoryBuilder enable(YAMLParser.Feature first, YAMLParser.Feature... other)

enable	back to summary
public YAMLFactoryBuilder enable(YAMLGenerator.Feature f)

enable	back to summary
public YAMLFactoryBuilder enable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other)

formatGeneratorFeaturesMask	back to summary
public int formatGeneratorFeaturesMask()

formatParserFeaturesMask	back to summary
public int formatParserFeaturesMask()

loaderOptions back to summary

loaderOptions	back to summary
public YAMLFactoryBuilder loaderOptions(LoaderOptions loaderOptions) Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` 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:LoaderOptions the `SnakeYAML` configuration to use when parsing YAML Returns:YAMLFactoryBuilder This builder instance, to allow chaining Since 2.14

public YAMLFactoryBuilder loaderOptions(LoaderOptions loaderOptions)

Configuration for underlying parser to follow, if specified; left as null for backwards compatibility (which means whatever default settings SnakeYAML deems best).

Parameters

loaderOptions:LoaderOptions: the SnakeYAML configuration to use when parsing YAML

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

Since

2.14

loaderOptions back to summary

loaderOptions	back to summary
public LoaderOptions loaderOptions() Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` 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:LoaderOptions the `SnakeYAML` configuration to use when parsing YAML Since 2.14

public LoaderOptions loaderOptions()

Configuration for underlying parser to follow, if specified; left as null for backwards compatibility (which means whatever default settings SnakeYAML deems best).

Returns:LoaderOptions: the SnakeYAML configuration to use when parsing YAML
Since: 2.14

stringQuotingChecker back to summary

stringQuotingChecker	back to summary
public YAMLFactoryBuilder stringQuotingChecker(StringQuotingChecker sqc) Method for specifying either custom `StringQuotingChecker` to use instead of default one, or, that default one (see `StringQuotingChecker.Default.instance()`) is to be used (when passing `null` Parameters sqc:StringQuotingChecker Checker to use (if non-null), or `null` to use the default one (see `StringQuotingChecker.Default.instance()`) Returns:YAMLFactoryBuilder This builder instance, to allow chaining

public YAMLFactoryBuilder stringQuotingChecker(StringQuotingChecker sqc)

Method for specifying either custom StringQuotingChecker to use instead of default one, or, that default one (see StringQuotingChecker.Default.instance()) is to be used (when passing null

Parameters

sqc:StringQuotingChecker: Checker to use (if non-null), or null to use the default one (see StringQuotingChecker.Default.instance())

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

stringQuotingChecker	back to summary
public StringQuotingChecker stringQuotingChecker()

yamlVersionToWrite back to summary

yamlVersionToWrite	back to summary
public YAMLFactoryBuilder yamlVersionToWrite(DumperOptions.Version v) Method for specifying YAML version for generator to use (to produce compliant output); if `null` passed, will let `SnakeYAML` use its default settings. Parameters v:DumperOptions.Version YAML specification version to use for output, if not-null; `null` for default handling Returns:YAMLFactoryBuilder This builder instance, to allow chaining

public YAMLFactoryBuilder yamlVersionToWrite(DumperOptions.Version v)

Method for specifying YAML version for generator to use (to produce compliant output); if null passed, will let SnakeYAML use its default settings.

Parameters

v:DumperOptions.Version: YAML specification version to use for output, if not-null; null for default handling

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

yamlVersionToWrite	back to summary
public DumperOptions.Version yamlVersionToWrite()

public Class YAMLFactoryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail