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

Class AbstractFileVersionProvider<T>

java.lang.Object

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

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

Type Parameters:

T - The target type supported

All Implemented Interfaces:

VersionProvider<T>

Direct Known Subclasses:

YamlFileVersionProvider

public abstract class AbstractFileVersionProvider<T>
extends AbstractVersionProvider<T>

Base class for all VersionProvider that use files

Since:

3.1.5

Author:

joseross

Field Summary

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
AbstractFileVersionProvider()

Method Summary

Modifier and Type	Method	Description
protected String	doGetVersion(UpgradeContext<T> context)
protected void	doSetVersion(UpgradeContext<T> context, String version)
protected Path	getFile(UpgradeContext<T> context)
protected abstract String	readVersionFromFile(Path file)
protected abstract void	writeVersionToFile(Path file, String version)

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

Constructor Details

AbstractFileVersionProvider

public AbstractFileVersionProvider()

Method Details

getFile

protected Path getFile(UpgradeContext<T> context)

doGetVersion

protected String doGetVersion(UpgradeContext<T> context)
                       throws Exception

Specified by:

doGetVersion in class AbstractVersionProvider<T>

Throws:

Exception

doSetVersion

protected void doSetVersion(UpgradeContext<T> context,
 String version)
                     throws Exception

Specified by:

doSetVersion in class AbstractVersionProvider<T>

Throws:

Exception

readVersionFromFile

protected abstract String readVersionFromFile(Path file)
                                       throws Exception

Throws:

Exception

writeVersionToFile

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

Throws:

Exception