info.magnolia.config.source.yaml

Class YamlReader

java.lang.Object

info.magnolia.config.source.yaml.YamlReader

@Singleton
public class YamlReader
extends Object

The YamlReader reads configuration from a yaml file and returns it as a map representing bean properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YamlReader.YamlConversionResult Result of YAML file conversion.

Constructor Summary

Constructors

Constructor and Description
YamlReader()

Method Summary

Modifier and Type	Method and Description
protected Object	doReadWithDependencies(info.magnolia.resourceloader.Resource res, MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)
protected org.yaml.snakeyaml.Yaml	newSnakeYaml(info.magnolia.resourceloader.Resource yamlResource, MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)
Object	read(info.magnolia.resourceloader.Resource res)
protected Object	readNoCast(info.magnolia.resourceloader.Resource res)
Map<String,Object>	readToMap(info.magnolia.resourceloader.Resource resource)
YamlReader.YamlConversionResult	readWithDependencies(info.magnolia.resourceloader.Resource resource)
YamlReader.YamlConversionResult	readWithDependencies(info.magnolia.resourceloader.Resource resource, MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)
void	registerCustomConstruct(String tag, org.yaml.snakeyaml.constructor.Construct construct)
void	registerCustomMultiConstruct(String tagPrefix, org.yaml.snakeyaml.constructor.Construct construct)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamlReader

public YamlReader()

Method Detail

registerCustomConstruct

public void registerCustomConstruct(String tag,
                                    org.yaml.snakeyaml.constructor.Construct construct)

registerCustomMultiConstruct

public void registerCustomMultiConstruct(String tagPrefix,
                                         org.yaml.snakeyaml.constructor.Construct construct)

read

public Object read(info.magnolia.resourceloader.Resource res)
            throws IOException

Throws:

IOException

readWithDependencies

public YamlReader.YamlConversionResult readWithDependencies(info.magnolia.resourceloader.Resource resource)
                                                     throws IOException

Throws:

IOException

readWithDependencies

public YamlReader.YamlConversionResult readWithDependencies(info.magnolia.resourceloader.Resource resource,
                                                            MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)
                                                     throws IOException

Throws:

IOException

doReadWithDependencies

protected Object doReadWithDependencies(info.magnolia.resourceloader.Resource res,
                                        MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)
                                 throws IOException

Throws:

IOException

readToMap

public Map<String,Object> readToMap(info.magnolia.resourceloader.Resource resource)
                             throws IOException

Throws:

IOException

readNoCast

protected Object readNoCast(info.magnolia.resourceloader.Resource res)
                     throws IOException

Throws:

IOException

newSnakeYaml

protected org.yaml.snakeyaml.Yaml newSnakeYaml(info.magnolia.resourceloader.Resource yamlResource,
                                               MgnlYamlConstructor.YamlConfigurationDependencyAggregator dependencyAggregator)