Jackson 3.0.1 · tools.jackson.dataformat.yaml.YAMLFactoryBuilder

Modifier and Type	Field and Description
protected DumpSettings	_dumpSettings Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLWriteFeature`s).
protected LoadSettings	_loadSettings 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 SpecVersion	_version YAML version for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).

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

Method Summary

Modifier and Type	Method and Description
public YAMLFactory	build() Implements abstract tools.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration.
public YAMLFactoryBuilder	configure(YAMLWriteFeature f, boolean state)
public YAMLFactoryBuilder	configure(YAMLReadFeature f, boolean state)
public YAMLFactoryBuilder	disable(YAMLWriteFeature f)
public YAMLFactoryBuilder	disable(YAMLWriteFeature first, YAMLWriteFeature... other)
public YAMLFactoryBuilder	disable(YAMLReadFeature f)
public YAMLFactoryBuilder	disable(YAMLReadFeature first, YAMLReadFeature... other)
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining dumperOptions(DumpSettings 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 `YAMLWriteFeature`s).
public DumpSettings	Returns: the `SnakeYAML` configuration to use when generating YAML dumpSettings() Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLWriteFeature`s).
public YAMLFactoryBuilder	enable(YAMLWriteFeature f)
public YAMLFactoryBuilder	enable(YAMLWriteFeature first, YAMLWriteFeature... other)
public YAMLFactoryBuilder	enable(YAMLReadFeature f)
public YAMLFactoryBuilder	enable(YAMLReadFeature first, YAMLReadFeature... other)
public YAMLFactoryBuilder	Returns: This builder instance, to allow chaining loadSettings(LoadSettings the `SnakeYAML` configuration to use when parsing YAML settings) Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `SnakeYAML` deems best).
public LoadSettings	Returns: the `SnakeYAML` configuration to use when parsing YAML loadSettings() 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(SpecVersion 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 SpecVersion	yamlVersionToWrite()

Inherited from tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder:: addDecorator generatorDecorators inputDecorator inputDecorator outputDecorator outputDecorator

Field Detail

_dumpSettings back to summary

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

protected DumpSettings _dumpSettings

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

These YAMLWriteFeatures 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

_loadSettings back to summary

_loadSettings	back to summary
protected LoadSettings _loadSettings 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.

protected LoadSettings _loadSettings

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.

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

_version back to summary

_version	back to summary
protected SpecVersion _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 SpecVersion _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 tools.jackson.core.TSFBuilder.build. Doc from tools.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration. Annotations @Override

public YAMLFactory build()

Implements abstract tools.jackson.core.TSFBuilder.build.

Doc from tools.jackson.core.TSFBuilder.build.

Method for constructing actual TokenStreamFactory instance, given configuration.

Annotations

@Override

configure	back to summary
public YAMLFactoryBuilder configure(YAMLWriteFeature f, boolean state)

configure	back to summary
public YAMLFactoryBuilder configure(YAMLReadFeature f, boolean state)

disable	back to summary
public YAMLFactoryBuilder disable(YAMLWriteFeature f)

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

disable	back to summary
public YAMLFactoryBuilder disable(YAMLReadFeature f)

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

dumperOptions back to summary

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

public YAMLFactoryBuilder dumperOptions(DumpSettings dumperOptions)

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

These YAMLWriteFeatures 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:DumpSettings: the SnakeYAML configuration to use when generating YAML

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

dumpSettings back to summary

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

public DumpSettings dumpSettings()

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

These YAMLWriteFeatures 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:DumpSettings: the SnakeYAML configuration to use when generating YAML

enable	back to summary
public YAMLFactoryBuilder enable(YAMLWriteFeature f)

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

enable	back to summary
public YAMLFactoryBuilder enable(YAMLReadFeature f)

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

loadSettings back to summary

loadSettings	back to summary
public YAMLFactoryBuilder loadSettings(LoadSettings settings) 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 settings:LoadSettings the `SnakeYAML` configuration to use when parsing YAML Returns:YAMLFactoryBuilder This builder instance, to allow chaining

public YAMLFactoryBuilder loadSettings(LoadSettings settings)

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

Parameters

settings:LoadSettings: the SnakeYAML configuration to use when parsing YAML

Returns:YAMLFactoryBuilder

This builder instance, to allow chaining

loadSettings back to summary

loadSettings	back to summary
public LoadSettings loadSettings() 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:LoadSettings the `SnakeYAML` configuration to use when parsing YAML

public LoadSettings loadSettings()

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

Returns:LoadSettings: the SnakeYAML configuration to use when parsing YAML

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(SpecVersion 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:SpecVersion 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(SpecVersion 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:SpecVersion: 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 SpecVersion yamlVersionToWrite()

public Class YAMLFactoryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail