SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.api.LoadSettingsBuilder

Modifier and Type	Field and Description
private boolean	allowDuplicateKeys
private boolean	allowRecursiveKeys
private Integer	bufferSize
private int	codePointLimit
private final Map<SettingKey, Object>	customProperties
private IntFunction<List<Object>>	defaultList
private IntFunction<Map<Object, Object>>	defaultMap
private IntFunction<Set<Object>>	defaultSet
private Optional<EnvConfig>	envConfig
private String	label
private int	maxAliasesForCollections
private boolean	parseComments
private Schema	schema
private Map<Tag, ConstructNode>	tagConstructors
private boolean	useMarks
private UnaryOperator<SpecVersion>	versionFunction

Access	Constructor and Description
pack-priv	LoadSettingsBuilder() Create builder

Method Summary

Modifier and Type	Method and Description
public LoadSettings	Returns: immutable LoadSettings build() Build immutable LoadSettings
public LoadSettingsBuilder	Returns: the builder with the provided value setAllowDuplicateKeys(boolean - if true, then the non-unique keys in a mapping are allowed (last key wins). False by default. allowDuplicateKeys) YAML 1.2 does require unique keys.
public LoadSettingsBuilder	Returns: the builder with the provided value setAllowRecursiveKeys(boolean - true to allow recursive structures as keys allowRecursiveKeys) Allow only non-recursive keys for maps and sets.
public LoadSettingsBuilder	Returns: the builder with the provided value setBufferSize(Integer - buffer size (in bytes) for input data bufferSize) Buffer size for incoming data stream.
public LoadSettingsBuilder	Returns: the builder with the provided value setCodePointLimit(int - the max allowed size of a single YAML document in a stream codePointLimit) The max amount of code points for every input YAML document in the stream.
public LoadSettingsBuilder	Returns: the builder with the provided value setCustomProperty(SettingKey - the key key, Object - the value behind the key value) Provide a custom property to be used later
public LoadSettingsBuilder	Returns: the builder with the provided value setDefaultList(IntFunction<List<Object>> - specified List implementation (as a function from init size) defaultList) Provide default List implementation.
public LoadSettingsBuilder	Returns: the builder with the provided value setDefaultMap(IntFunction<Map<Object, Object>> - specified Map implementation (as a function from init size) defaultMap) Provide default Map implementation.
public LoadSettingsBuilder	Returns: the builder with the provided value setDefaultSet(IntFunction<Set<Object>> - specified Set implementation (as a function from init size) defaultSet) Provide default Set implementation.
public LoadSettingsBuilder	Returns: the builder with the provided value setEnvConfig(Optional<EnvConfig> - non-empty configuration to substitute variables envConfig) Define EnvConfig to parse ENV format.
public LoadSettingsBuilder	Returns: the builder with the provided value setLabel(String - meaningful label to indicate the input source label) Label for the input data.
public LoadSettingsBuilder	Returns: the builder with the provided value setMaxAliasesForCollections(int - max number of aliases. More than 50 might be very dangerous. Default is 50 maxAliasesForCollections) Restrict the number of aliases for collection nodes to prevent a Billion laughs attack.
public LoadSettingsBuilder	Returns: the builder with the provided value setParseComments(boolean - use true to parse comments to the presentation tree (Node) parseComments) Parse comments to the presentation tree (Node).
public LoadSettingsBuilder	Returns: the builder with the provided value setSchema(Schema to be used for parsing schema) Provide either recommended or custom schema instead of default * `org.snakeyaml.engine.v2.schema.CoreSchema` These 3 are available `org.snakeyaml.engine.v2.schema.FailsafeSchema`, `org.snakeyaml.engine.v2.schema.JsonSchema`, `org.snakeyaml.engine.v2.schema.CoreSchema`.
public LoadSettingsBuilder	Returns: the builder with the provided value setTagConstructors(Map<Tag, ConstructNode> - the map from a Tag to its constructor tagConstructors) Provide constructors for the specified tags.
public LoadSettingsBuilder	Returns: the builder with the provided value setUseMarks(boolean - use false to save resources but use less informative error messages (no line and context) useMarks) Marks are only used for error messages.
public LoadSettingsBuilder	Returns: the builder with the provided value setVersionFunction(UnaryOperator<SpecVersion> - define the way to manage the YAML version. By default, 1.* versions are accepted and treated as YAML 1.2. Other versions fail to parse (YamlVersionException is thown) versionFunction) Manage YAML directive value which defines the version of the YAML specification.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allowDuplicateKeys	back to summary
private boolean allowDuplicateKeys

allowRecursiveKeys	back to summary
private boolean allowRecursiveKeys

bufferSize	back to summary
private Integer bufferSize

codePointLimit	back to summary
private int codePointLimit

customProperties	back to summary
private final Map<SettingKey, Object> customProperties

defaultList	back to summary
private IntFunction<List<Object>> defaultList

defaultMap	back to summary
private IntFunction<Map<Object, Object>> defaultMap

defaultSet	back to summary
private IntFunction<Set<Object>> defaultSet

envConfig	back to summary
private Optional<EnvConfig> envConfig

label	back to summary
private String label

maxAliasesForCollections	back to summary
private int maxAliasesForCollections

parseComments	back to summary
private boolean parseComments

schema	back to summary
private Schema schema

tagConstructors	back to summary
private Map<Tag, ConstructNode> tagConstructors

useMarks	back to summary
private boolean useMarks

versionFunction	back to summary
private UnaryOperator<SpecVersion> versionFunction

LoadSettingsBuilder	back to summary
pack-priv LoadSettingsBuilder() Create builder

Method Detail

build	back to summary
public LoadSettings build() Build immutable LoadSettings Returns:LoadSettings immutable LoadSettings

build

back to summary

public LoadSettings build()

Build immutable LoadSettings

Returns:LoadSettings: immutable LoadSettings

setAllowDuplicateKeys	back to summary
public LoadSettingsBuilder setAllowDuplicateKeys(boolean allowDuplicateKeys) YAML 1.2 does require unique keys. To support the backwards compatibility it is possible to select what should happen when non-unique keys are detected. Parameters allowDuplicateKeys:boolean - if true, then the non-unique keys in a mapping are allowed (last key wins). False by default. Returns:LoadSettingsBuilder the builder with the provided value

setAllowDuplicateKeys

back to summary

public LoadSettingsBuilder setAllowDuplicateKeys(boolean allowDuplicateKeys)

YAML 1.2 does require unique keys. To support the backwards compatibility it is possible to select what should happen when non-unique keys are detected.

Parameters

allowDuplicateKeys:boolean: - if true, then the non-unique keys in a mapping are allowed (last key wins). False by default.

Returns:LoadSettingsBuilder

the builder with the provided value

setAllowRecursiveKeys	back to summary
public LoadSettingsBuilder setAllowRecursiveKeys(boolean allowRecursiveKeys) Allow only non-recursive keys for maps and sets. By default, is it not allowed. Even though YAML allows to use anything as a key, it may cause unexpected issues when loading recursive structures. Parameters allowRecursiveKeys:boolean - true to allow recursive structures as keys Returns:LoadSettingsBuilder the builder with the provided value

setAllowRecursiveKeys

back to summary

public LoadSettingsBuilder setAllowRecursiveKeys(boolean allowRecursiveKeys)

Allow only non-recursive keys for maps and sets. By default, is it not allowed. Even though YAML allows to use anything as a key, it may cause unexpected issues when loading recursive structures.

Parameters

allowRecursiveKeys:boolean: - true to allow recursive structures as keys

Returns:LoadSettingsBuilder

the builder with the provided value

setBufferSize	back to summary
public LoadSettingsBuilder setBufferSize(Integer bufferSize) Buffer size for incoming data stream. If the incoming stream is already buffered, then changing the buffer does not improve the performance Parameters bufferSize:Integer - buffer size (in bytes) for input data Returns:LoadSettingsBuilder the builder with the provided value

setBufferSize

back to summary

public LoadSettingsBuilder setBufferSize(Integer bufferSize)

Buffer size for incoming data stream. If the incoming stream is already buffered, then changing the buffer does not improve the performance

Parameters

bufferSize:Integer: - buffer size (in bytes) for input data

Returns:LoadSettingsBuilder

the builder with the provided value

setCodePointLimit	back to summary
public LoadSettingsBuilder setCodePointLimit(int codePointLimit) The max amount of code points for every input YAML document in the stream. Please be aware that byte limit depends on the encoding. Parameters codePointLimit:int - the max allowed size of a single YAML document in a stream Returns:LoadSettingsBuilder the builder with the provided value

setCodePointLimit

back to summary

public LoadSettingsBuilder setCodePointLimit(int codePointLimit)

The max amount of code points for every input YAML document in the stream. Please be aware that byte limit depends on the encoding.

Parameters

codePointLimit:int: - the max allowed size of a single YAML document in a stream

Returns:LoadSettingsBuilder

the builder with the provided value

setCustomProperty	back to summary
public LoadSettingsBuilder setCustomProperty(SettingKey key, Object value) Provide a custom property to be used later Parameters key:SettingKey - the key value:Object - the value behind the key Returns:LoadSettingsBuilder the builder with the provided value

setCustomProperty

back to summary

public LoadSettingsBuilder setCustomProperty(SettingKey key, Object value)

Provide a custom property to be used later

Parameters

key:SettingKey: - the key
value:Object: - the value behind the key

Returns:LoadSettingsBuilder

the builder with the provided value

setDefaultList back to summary

setDefaultList	back to summary
public LoadSettingsBuilder setDefaultList(IntFunction<List<Object>> defaultList) Provide default List implementation. `ArrayList` is used if nothing provided. Parameters defaultList:IntFunction<List<Object>> - specified List implementation (as a function from init size) Returns:LoadSettingsBuilder the builder with the provided value

public LoadSettingsBuilder setDefaultList(IntFunction<List<Object>> defaultList)

Provide default List implementation. ArrayList is used if nothing provided.

Parameters

defaultList:IntFunction<List<Object>>: - specified List implementation (as a function from init size)

Returns:LoadSettingsBuilder

the builder with the provided value

setDefaultMap back to summary

setDefaultMap	back to summary
public LoadSettingsBuilder setDefaultMap(IntFunction<Map<Object, Object>> defaultMap) Provide default Map implementation. `LinkedHashMap` is used if nothing provided. Parameters defaultMap:IntFunction<Map<Object, Object>> - specified Map implementation (as a function from init size) Returns:LoadSettingsBuilder the builder with the provided value

public LoadSettingsBuilder setDefaultMap(IntFunction<Map<Object, Object>> defaultMap)

Provide default Map implementation. LinkedHashMap is used if nothing provided.

Parameters

defaultMap:IntFunction<Map<Object, Object>>: - specified Map implementation (as a function from init size)

Returns:LoadSettingsBuilder

the builder with the provided value

setDefaultSet back to summary

setDefaultSet	back to summary
public LoadSettingsBuilder setDefaultSet(IntFunction<Set<Object>> defaultSet) Provide default Set implementation. `LinkedHashSet` is used if nothing provided. Parameters defaultSet:IntFunction<Set<Object>> - specified Set implementation (as a function from init size) Returns:LoadSettingsBuilder the builder with the provided value

public LoadSettingsBuilder setDefaultSet(IntFunction<Set<Object>> defaultSet)

Provide default Set implementation. LinkedHashSet is used if nothing provided.

Parameters

defaultSet:IntFunction<Set<Object>>: - specified Set implementation (as a function from init size)

Returns:LoadSettingsBuilder

the builder with the provided value

setEnvConfig	back to summary
public LoadSettingsBuilder setEnvConfig(Optional<EnvConfig> envConfig) Define EnvConfig to parse ENV format. If not set explicitly the variable substitution is not applied. Parameters envConfig:Optional<EnvConfig> - non-empty configuration to substitute variables Returns:LoadSettingsBuilder the builder with the provided value See Also Variable substitution

setEnvConfig

back to summary

public LoadSettingsBuilder setEnvConfig(Optional<EnvConfig> envConfig)

Define EnvConfig to parse ENV format. If not set explicitly the variable substitution is not applied.

Parameters

envConfig:Optional<EnvConfig>: - non-empty configuration to substitute variables

Returns:LoadSettingsBuilder

the builder with the provided value

See Also

Variable substitution

setLabel	back to summary
public LoadSettingsBuilder setLabel(String label) Label for the input data. Can be used to improve the error message. Parameters label:String - meaningful label to indicate the input source Returns:LoadSettingsBuilder the builder with the provided value

setLabel

back to summary

public LoadSettingsBuilder setLabel(String label)

Label for the input data. Can be used to improve the error message.

Parameters

label:String: - meaningful label to indicate the input source

Returns:LoadSettingsBuilder

the builder with the provided value

setMaxAliasesForCollections	back to summary
public LoadSettingsBuilder setMaxAliasesForCollections(int maxAliasesForCollections) Restrict the number of aliases for collection nodes to prevent a Billion laughs attack. The purpose of this setting is to force SnakeYAML to fail before a lot of CPU and memory resources are allocated for the parser. Aliases for scalar nodes do not count because they do not grow exponentially. Parameters maxAliasesForCollections:int - max number of aliases. More than 50 might be very dangerous. Default is 50 Returns:LoadSettingsBuilder the builder with the provided value

setMaxAliasesForCollections

back to summary

public LoadSettingsBuilder setMaxAliasesForCollections(int maxAliasesForCollections)

Restrict the number of aliases for collection nodes to prevent a Billion laughs attack. The purpose of this setting is to force SnakeYAML to fail before a lot of CPU and memory resources are allocated for the parser. Aliases for scalar nodes do not count because they do not grow exponentially.

Parameters

maxAliasesForCollections:int: - max number of aliases. More than 50 might be very dangerous. Default is 50

Returns:LoadSettingsBuilder

the builder with the provided value

setParseComments	back to summary
public LoadSettingsBuilder setParseComments(boolean parseComments) Parse comments to the presentation tree (Node). False by default Parameters parseComments:boolean - use true to parse comments to the presentation tree (Node) Returns:LoadSettingsBuilder the builder with the provided value

setParseComments

back to summary

public LoadSettingsBuilder setParseComments(boolean parseComments)

Parse comments to the presentation tree (Node). False by default

Parameters

parseComments:boolean: - use true to parse comments to the presentation tree (Node)

Returns:LoadSettingsBuilder

the builder with the provided value

setSchema back to summary

setSchema	back to summary
public LoadSettingsBuilder setSchema(Schema schema) Provide either recommended or custom schema instead of default * `org.snakeyaml.engine.v2.schema.CoreSchema` These 3 are available `org.snakeyaml.engine.v2.schema.FailsafeSchema`, `org.snakeyaml.engine.v2.schema.JsonSchema`, `org.snakeyaml.engine.v2.schema.CoreSchema`. Parameters schema:Schema to be used for parsing Returns:LoadSettingsBuilder the builder with the provided value

public LoadSettingsBuilder setSchema(Schema schema)

Provide either recommended or custom schema instead of default * org.snakeyaml.engine.v2.schema.CoreSchema These 3 are available org.snakeyaml.engine.v2.schema.FailsafeSchema, org.snakeyaml.engine.v2.schema.JsonSchema, org.snakeyaml.engine.v2.schema.CoreSchema.

Parameters

schema:Schema: to be used for parsing

Returns:LoadSettingsBuilder

the builder with the provided value

setTagConstructors	back to summary
public LoadSettingsBuilder setTagConstructors(Map<Tag, ConstructNode> tagConstructors) Provide constructors for the specified tags. Parameters tagConstructors:Map<Tag, ConstructNode> - the map from a Tag to its constructor Returns:LoadSettingsBuilder the builder with the provided value

setTagConstructors

back to summary

public LoadSettingsBuilder setTagConstructors(Map<Tag, ConstructNode> tagConstructors)

Provide constructors for the specified tags.

Parameters

tagConstructors:Map<Tag, ConstructNode>: - the map from a Tag to its constructor

Returns:LoadSettingsBuilder

the builder with the provided value

setUseMarks	back to summary
public LoadSettingsBuilder setUseMarks(boolean useMarks) Marks are only used for error messages. But they require a lot of memory. True by default. Parameters useMarks:boolean - use false to save resources but use less informative error messages (no line and context) Returns:LoadSettingsBuilder the builder with the provided value

setUseMarks

back to summary

public LoadSettingsBuilder setUseMarks(boolean useMarks)

Marks are only used for error messages. But they require a lot of memory. True by default.

Parameters

useMarks:boolean: - use false to save resources but use less informative error messages (no line and context)

Returns:LoadSettingsBuilder

the builder with the provided value

setVersionFunction	back to summary
public LoadSettingsBuilder setVersionFunction(UnaryOperator<SpecVersion> versionFunction) Manage YAML directive value which defines the version of the YAML specification. This parser supports YAML 1.2 but it can parse most of YAML 1.1 and YAML 1.0 This function allows to control the version management. For instance if the document contains old version the parser can be adapted to compensate the problem. Or it can fail to indicate that the incoming version is not supported. Parameters versionFunction:UnaryOperator<SpecVersion> - define the way to manage the YAML version. By default, 1.* versions are accepted and treated as YAML 1.2. Other versions fail to parse (YamlVersionException is thown) Returns:LoadSettingsBuilder the builder with the provided value

setVersionFunction

back to summary

public LoadSettingsBuilder setVersionFunction(UnaryOperator<SpecVersion> versionFunction)

Manage YAML directive value which defines the version of the YAML specification. This parser supports YAML 1.2 but it can parse most of YAML 1.1 and YAML 1.0

This function allows to control the version management. For instance if the document contains old version the parser can be adapted to compensate the problem. Or it can fail to indicate that the incoming version is not supported.

Parameters

versionFunction:UnaryOperator<SpecVersion>: - define the way to manage the YAML version. By default, 1.* versions are accepted and treated as YAML 1.2. Other versions fail to parse (YamlVersionException is thown)

Returns:LoadSettingsBuilder

the builder with the provided value

public final Class LoadSettingsBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail