Package org.craftercms.commons.upgrade.impl.providers

Class YamlFileVersionProvider<T>

java.lang.Object

org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider<T>

org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider<T>

org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider<T>

Type Parameters:

T - The target type supported

All Implemented Interfaces:

VersionProvider<T>

public class YamlFileVersionProvider<T>
extends AbstractFileVersionProvider<T>

Implementation of VersionProvider that handles YAML files

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.yaml.snakeyaml.Yaml	yaml

Fields inherited from class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider

defaultValue, logger

Fields inherited from interface org.craftercms.commons.upgrade.VersionProvider

SKIP, VERSION

Constructor Summary

Constructors

Constructor	Description
YamlFileVersionProvider()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	loadFile(Path file)
protected String	readVersionFromFile(Path file)
protected void	writeVersionToFile(Path file, String version)

Methods inherited from class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider

doGetVersion, doSetVersion, getFile

Methods inherited from class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider

getVersion, setDefaultValue, setVersion

Methods inherited from class java.lang.Object

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

Field Details

yaml

protected final org.yaml.snakeyaml.Yaml yaml

Constructor Details

YamlFileVersionProvider

public YamlFileVersionProvider()

Method Details

loadFile

protected Map<String,Object> loadFile(Path file)
                               throws IOException

Throws:

IOException

readVersionFromFile

protected String readVersionFromFile(Path file)
                              throws Exception

Specified by:

readVersionFromFile in class AbstractFileVersionProvider<T>

Throws:

Exception

writeVersionToFile

protected void writeVersionToFile(Path file,
 String version)
                           throws Exception

Specified by:

writeVersionToFile in class AbstractFileVersionProvider<T>

Throws:

Exception