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

Class AbstractVersionProvider<T>

java.lang.Object

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

Type Parameters:

T - The target type supported

All Implemented Interfaces:

VersionProvider<T>

Direct Known Subclasses:

AbstractFileVersionProvider

public abstract class AbstractVersionProvider<T>
extends Object
implements VersionProvider<T>

Base class for all VersionProvider implementations

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	defaultValue	The default value to use when no version is found, defaults to VersionProvider.SKIP
protected org.slf4j.Logger	logger

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

SKIP, VERSION

Constructor Summary

Constructors

Constructor	Description
AbstractVersionProvider()

Method Summary

Modifier and Type	Method	Description
protected abstract String	doGetVersion(UpgradeContext<T> context)
protected abstract void	doSetVersion(UpgradeContext<T> context, String version)
String	getVersion(UpgradeContext<T> context)	Returns the current version
void	setDefaultValue(String defaultValue)
void	setVersion(UpgradeContext<T> context, String version)	Updates the current version

Methods inherited from class java.lang.Object

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

Field Details

logger

protected org.slf4j.Logger logger

defaultValue

protected String defaultValue

The default value to use when no version is found, defaults to VersionProvider.SKIP

Constructor Details

AbstractVersionProvider

public AbstractVersionProvider()

Method Details

setDefaultValue

public void setDefaultValue(String defaultValue)

getVersion

public String getVersion(UpgradeContext<T> context)
                  throws UpgradeException

Description copied from interface: VersionProvider

Returns the current version

Specified by:

getVersion in interface VersionProvider<T>

Parameters:

context - the upgrade context

Returns:

version number

Throws:

UpgradeException - if there is any error getting the current version

doGetVersion

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

Throws:

Exception

setVersion

public void setVersion(UpgradeContext<T> context,
 String version)
                throws UpgradeException

Description copied from interface: VersionProvider

Updates the current version

Specified by:

setVersion in interface VersionProvider<T>

Parameters:

context - the upgrade context

version - the new version

Throws:

UpgradeException - if there is any error setting the current version

doSetVersion

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

Throws:

Exception