Modifier and Type	Class and Description
public static interface	YamlProcessor.DocumentMatcher Strategy interface used to test if properties match.
public static interface	YamlProcessor.MatchCallback Callback interface used to process the YAML parsing results.
public static enum	YamlProcessor.MatchStatus Status returned from `DocumentMatcher#matches(java.util.Properties)`.
public static enum	YamlProcessor.ResolutionMethod Method to use for resolving resources.
private class	YamlProcessor.SupportedTagInspector

Modifier and Type	Field and Description
private List<YamlProcessor.DocumentMatcher>	documentMatchers
private final Log	logger
private boolean	matchDefault
private YamlProcessor.ResolutionMethod	resolutionMethod
private Resource[]	resources
private Set<String>	supportedTypes

Access	Constructor and Description
public	YamlProcessor()

Method Summary

Modifier and Type	Method and Description
private Map<String, Object>	asMap(Object object)
private void	buildFlattenedMap(Map<String, Object> result, Map<String, Object> source, String path)
protected Yaml	createYaml() Create the `Yaml` instance to use.
protected final Map<String, Object>	Returns: a flattened map getFlattenedMap(Map<String, Object> the source map source) Return a flattened version of the given map, recursively following any nested Map or Collection values.
private void	handleProcessError(Resource resource, IOException ex)
protected void	process(YamlProcessor.MatchCallback a callback to delegate to once matching documents are found callback) Provide an opportunity for subclasses to process the Yaml parsed from the supplied resources.
private boolean	process(YamlProcessor.MatchCallback callback, Yaml yaml, Resource resource)
private boolean	process(Map<String, Object> map, YamlProcessor.MatchCallback callback)
public void	setDocumentMatchers(YamlProcessor.DocumentMatcher... matchers) A map of document matchers allowing callers to selectively use only some of the documents in a YAML resource.
public void	setMatchDefault(boolean matchDefault) Flag indicating that a document for which all the `document matchers` abstain will nevertheless match.
public void	setResolutionMethod(YamlProcessor.ResolutionMethod resolutionMethod) Method to use for resolving resources.
public void	setResources(Resource... resources) Set locations of YAML `resources` to be loaded.
public void	setSupportedTypes(Class<?>... the supported types, or an empty array to clear the supported types supportedTypes) Set the supported types that can be loaded from YAML documents.

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

Field Detail

documentMatchers	back to summary
private List<YamlProcessor.DocumentMatcher> documentMatchers

logger	back to summary
private final Log logger

matchDefault	back to summary
private boolean matchDefault

resolutionMethod	back to summary
private YamlProcessor.ResolutionMethod resolutionMethod

resources	back to summary
private Resource[] resources

supportedTypes	back to summary
private Set<String> supportedTypes

Constructor Detail

YamlProcessor	back to summary
public YamlProcessor()

Method Detail

asMap	back to summary
private Map<String, Object> asMap(Object object) Annotations @SuppressWarnings:rawtypes, unchecked

buildFlattenedMap	back to summary
private void buildFlattenedMap(Map<String, Object> result, Map<String, Object> source, String path) Annotations @SuppressWarnings:rawtypes, unchecked

createYaml back to summary

createYaml	back to summary
protected Yaml createYaml() Create the `Yaml` instance to use. The default implementation sets the "allowDuplicateKeys" flag to `false`, enabling built-in duplicate key handling. If custom supported types have been configured, the default implementation creates a `Yaml` instance that filters out unsupported types encountered in YAML documents. If an unsupported type is encountered, a `ComposerException` will be thrown when the node is processed. See Also `LoaderOptions#setAllowDuplicateKeys(boolean)`

protected Yaml createYaml()

Create the Yaml instance to use.

The default implementation sets the "allowDuplicateKeys" flag to false, enabling built-in duplicate key handling.

If custom supported types have been configured, the default implementation creates a Yaml instance that filters out unsupported types encountered in YAML documents. If an unsupported type is encountered, a ComposerException will be thrown when the node is processed.

See Also: LoaderOptions#setAllowDuplicateKeys(boolean)

getFlattenedMap back to summary

getFlattenedMap	back to summary
protected final Map<String, Object> getFlattenedMap(Map<String, Object> source) Return a flattened version of the given map, recursively following any nested Map or Collection values. Entries from the resulting map retain the same order as the source. When called with the Map from a `MatchCallback` the result will contain the same values as the `MatchCallback` Properties. Parameters source:Map<String, Object> the source map Returns:Map<String, Object> a flattened map Since 4.1.3

protected final Map<String, Object> getFlattenedMap(Map<String, Object> source)

Return a flattened version of the given map, recursively following any nested Map or Collection values. Entries from the resulting map retain the same order as the source. When called with the Map from a MatchCallback the result will contain the same values as the MatchCallback Properties.

Parameters

source:Map<String, Object>: the source map

Returns:Map<String, Object>

a flattened map

Since

4.1.3

handleProcessError	back to summary
private void handleProcessError(Resource resource, IOException ex)

process back to summary

process	back to summary
protected void process(YamlProcessor.MatchCallback callback) Provide an opportunity for subclasses to process the Yaml parsed from the supplied resources. Each resource is parsed in turn and the documents inside checked against the `matchers`. If a document matches it is passed into the callback, along with its representation as Properties. Depending on the `setResolutionMethod(ResolutionMethod)` not all the documents will be parsed. Parameters callback:YamlProcessor.MatchCallback a callback to delegate to once matching documents are found See Also `createYaml()`

protected void process(YamlProcessor.MatchCallback callback)

Provide an opportunity for subclasses to process the Yaml parsed from the supplied resources. Each resource is parsed in turn and the documents inside checked against the matchers. If a document matches it is passed into the callback, along with its representation as Properties. Depending on the setResolutionMethod(ResolutionMethod) not all the documents will be parsed.

Parameters

callback:YamlProcessor.MatchCallback: a callback to delegate to once matching documents are found

See Also

createYaml()

process	back to summary
private boolean process(YamlProcessor.MatchCallback callback, Yaml yaml, Resource resource)

process	back to summary
private boolean process(Map<String, Object> map, YamlProcessor.MatchCallback callback)

setDocumentMatchers back to summary

setDocumentMatchers	back to summary
public void setDocumentMatchers(YamlProcessor.DocumentMatcher... matchers) A map of document matchers allowing callers to selectively use only some of the documents in a YAML resource. In YAML documents are separated by `---` lines, and each document is converted to properties before the match is made. E.g. environment: dev url: https://dev.bar.com name: Developer Setup --- environment: prod url:https://foo.bar.com name: My Cool App when mapped with setDocumentMatchers(properties -> ("prod".equals(properties.getProperty("environment")) ? MatchStatus.FOUND : MatchStatus.NOT_FOUND)); would end up as environment=prod url=https://foo.bar.com name=My Cool App

public void setDocumentMatchers(YamlProcessor.DocumentMatcher... matchers)

A map of document matchers allowing callers to selectively use only some of the documents in a YAML resource. In YAML documents are separated by --- lines, and each document is converted to properties before the match is made. E.g.

environment: dev
url: https://dev.bar.com
name: Developer Setup
---
environment: prod
url:https://foo.bar.com
name: My Cool App

when mapped with

setDocumentMatchers(properties ->
    ("prod".equals(properties.getProperty("environment")) ? MatchStatus.FOUND : MatchStatus.NOT_FOUND));

would end up as

environment=prod
url=https://foo.bar.com
name=My Cool App

setMatchDefault	back to summary
public void setMatchDefault(boolean matchDefault) Flag indicating that a document for which all the `document matchers` abstain will nevertheless match. Default is `true`.

setResolutionMethod	back to summary
public void setResolutionMethod(YamlProcessor.ResolutionMethod resolutionMethod) Method to use for resolving resources. Each resource will be converted to a Map, so this property is used to decide which map entries to keep in the final output from this factory. Default is `ResolutionMethod#OVERRIDE`.

setResources back to summary

setResources	back to summary
public void setResources(Resource... resources) Set locations of YAML `resources` to be loaded. See Also `ResolutionMethod`

public void setResources(Resource... resources)

Set locations of YAML resources to be loaded.

See Also: ResolutionMethod

setSupportedTypes back to summary

setSupportedTypes	back to summary
public void setSupportedTypes(Class<?>... supportedTypes) Set the supported types that can be loaded from YAML documents. If no supported types are configured, only Java standard classes (as defined in `org.yaml.snakeyaml.constructor.SafeConstructor`) encountered in YAML documents will be supported. If an unsupported type is encountered, a `ComposerException` will be thrown when the corresponding YAML node is processed. Parameters supportedTypes:Class<?>[] the supported types, or an empty array to clear the supported types Since 5.1.16 See Also `createYaml()`

public void setSupportedTypes(Class<?>... supportedTypes)

Set the supported types that can be loaded from YAML documents.

If no supported types are configured, only Java standard classes (as defined in org.yaml.snakeyaml.constructor.SafeConstructor) encountered in YAML documents will be supported. If an unsupported type is encountered, a ComposerException will be thrown when the corresponding YAML node is processed.

Parameters

supportedTypes:Class<?>[]: the supported types, or an empty array to clear the supported types

Since

5.1.16

See Also

createYaml()

org.springframework.beans.factory.config back to summary

public Interface YamlProcessor.DocumentMatcher

Annotations

@FunctionalInterface

Strategy interface used to test if properties match.

Method Summary

Modifier and Type	Method and Description
public YamlProcessor.MatchStatus	Returns: the status of the match matches(Properties the properties to test properties) Test if the given properties match.

Method Detail

matches	back to summary
public YamlProcessor.MatchStatus matches(Properties properties) Test if the given properties match. Parameters properties:Properties the properties to test Returns:YamlProcessor.MatchStatus the status of the match

matches

back to summary

public YamlProcessor.MatchStatus matches(Properties properties)

Test if the given properties match.

Parameters

properties:Properties: the properties to test

Returns:YamlProcessor.MatchStatus

the status of the match

org.springframework.beans.factory.config back to summary

public Interface YamlProcessor.MatchCallback

Annotations

@FunctionalInterface

Callback interface used to process the YAML parsing results.

Method Summary

Modifier and Type	Method and Description
public void	process(Properties the properties to process (as a flattened representation with indexed keys in case of a collection or map) properties, Map<String, Object> the result map (preserving the original value structure in the YAML document) map) Process the given representation of the parsing results.

Method Detail

process	back to summary
public void process(Properties properties, Map<String, Object> map) Process the given representation of the parsing results. Parameters properties:Properties the properties to process (as a flattened representation with indexed keys in case of a collection or map) map:Map<String, Object> the result map (preserving the original value structure in the YAML document)

process

back to summary

public void process(Properties properties, Map<String, Object> map)

Process the given representation of the parsing results.

Parameters

properties:Properties: the properties to process (as a flattened representation with indexed keys in case of a collection or map)
map:Map<String, Object>: the result map (preserving the original value structure in the YAML document)

org.springframework.beans.factory.config back to summary

public final Enum YamlProcessor.MatchStatus

Class Inheritance

extends Enum<YamlProcessor.MatchStatus>

java.lang.Object
java.lang.Enum
org.springframework.beans.factory.config.YamlProcessor.MatchStatus

Status returned from DocumentMatcher#matches(java.util.Properties).

Field Summary

Modifier and Type	Field and Description
public static final YamlProcessor.MatchStatus	ABSTAIN The matcher should not be considered.
public static final YamlProcessor.MatchStatus	FOUND A match was found.
public static final YamlProcessor.MatchStatus	NOT_FOUND No match was found.

Constructor Summary

Access	Constructor and Description
private	MatchStatus()

Method Summary

Modifier and Type	Method and Description
public static YamlProcessor.MatchStatus	getMostSpecific(YamlProcessor.MatchStatus a, YamlProcessor.MatchStatus b) Compare two `MatchStatus` items, returning the most specific status.
public static YamlProcessor.MatchStatus	valueOf(String name)
public static YamlProcessor.MatchStatus[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABSTAIN	back to summary
public static final YamlProcessor.MatchStatus ABSTAIN The matcher should not be considered.

FOUND	back to summary
public static final YamlProcessor.MatchStatus FOUND A match was found.

NOT_FOUND	back to summary
public static final YamlProcessor.MatchStatus NOT_FOUND No match was found.

Constructor Detail

MatchStatus	back to summary
private MatchStatus()

Method Detail

getMostSpecific	back to summary
public static YamlProcessor.MatchStatus getMostSpecific(YamlProcessor.MatchStatus a, YamlProcessor.MatchStatus b) Compare two `MatchStatus` items, returning the most specific status.

valueOf	back to summary
public static YamlProcessor.MatchStatus valueOf(String name)

values	back to summary
public static YamlProcessor.MatchStatus[] values()

org.springframework.beans.factory.config back to summary

public final Enum YamlProcessor.ResolutionMethod

Class Inheritance

extends Enum<YamlProcessor.ResolutionMethod>

java.lang.Object
java.lang.Enum
org.springframework.beans.factory.config.YamlProcessor.ResolutionMethod

Method to use for resolving resources.

Field Summary

Modifier and Type	Field and Description
public static final YamlProcessor.ResolutionMethod	FIRST_FOUND Take the first resource in the list that exists and use just that.
public static final YamlProcessor.ResolutionMethod	OVERRIDE Replace values from earlier in the list.
public static final YamlProcessor.ResolutionMethod	OVERRIDE_AND_IGNORE Replace values from earlier in the list, ignoring any failures.

Constructor Summary

Access	Constructor and Description
private	ResolutionMethod()

Method Summary

Modifier and Type	Method and Description
public static YamlProcessor.ResolutionMethod	valueOf(String name)
public static YamlProcessor.ResolutionMethod[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FIRST_FOUND	back to summary
public static final YamlProcessor.ResolutionMethod FIRST_FOUND Take the first resource in the list that exists and use just that.

OVERRIDE	back to summary
public static final YamlProcessor.ResolutionMethod OVERRIDE Replace values from earlier in the list.

OVERRIDE_AND_IGNORE	back to summary
public static final YamlProcessor.ResolutionMethod OVERRIDE_AND_IGNORE Replace values from earlier in the list, ignoring any failures.

Constructor Detail

ResolutionMethod	back to summary
private ResolutionMethod()

Method Detail

valueOf	back to summary
public static YamlProcessor.ResolutionMethod valueOf(String name)

values	back to summary
public static YamlProcessor.ResolutionMethod[] values()

org.springframework.beans.factory.config back to summary

private Class YamlProcessor.SupportedTagInspector

Class Inheritance

extends Object
implements TagInspector

java.lang.Object
org.springframework.beans.factory.config.YamlProcessor.SupportedTagInspector

All Implemented Interfaces

org.yaml.snakeyaml.inspector.TagInspector

Constructor Summary

Access	Constructor and Description
private	SupportedTagInspector()

Method Summary

Modifier and Type	Method and Description
public boolean	isGlobalTagAllowed(Tag - the global tag to check tag) Implements org.yaml.snakeyaml.inspector.TagInspector.isGlobalTagAllowed. Check

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

Constructor Detail

SupportedTagInspector	back to summary
private SupportedTagInspector()

Method Detail

isGlobalTagAllowed

back to summary

public boolean isGlobalTagAllowed(Tag tag)

Implements org.yaml.snakeyaml.inspector.TagInspector.isGlobalTagAllowed.

Doc from org.yaml.snakeyaml.inspector.TagInspector.isGlobalTagAllowed.

Check

Parameters

tag:Tag: - the global tag to check

Returns:boolean

true when the custom global tag is allowed to create a custom Java instance

Annotations

@Override

public abstract Class YamlProcessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface YamlProcessor.DocumentMatcher

Method Summary

Method Detail

public Interface YamlProcessor.MatchCallback

Method Summary

Method Detail

public final Enum YamlProcessor.MatchStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum YamlProcessor.ResolutionMethod

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class YamlProcessor.SupportedTagInspector

Constructor Summary

Method Summary

Constructor Detail

Method Detail