org.craftercms.commons.upgrade.impl.providers

Class AbstractFileVersionProvider

java.lang.Object

org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider

org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider

All Implemented Interfaces:

VersionProvider

Direct Known Subclasses:

YamlFileVersionProvider

public abstract class AbstractFileVersionProvider
extends AbstractVersionProvider

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

Method Summary

Modifier and Type	Method and Description
protected String	doGetVersion(Object target)
protected void	doSetVersion(Object target, String version)
protected Path	getFile(Object target)
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 Detail

AbstractFileVersionProvider

public AbstractFileVersionProvider()

Method Detail

getFile

protected Path getFile(Object target)

doGetVersion

protected String doGetVersion(Object target)
                       throws Exception

Specified by:

doGetVersion in class AbstractVersionProvider

Throws:

Exception

doSetVersion

protected void doSetVersion(Object target,
                            String version)
                     throws Exception

Specified by:

doSetVersion in class AbstractVersionProvider

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