org.craftercms.commons.upgrade.impl.providers

Class AbstractVersionProvider

java.lang.Object

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

All Implemented Interfaces:

VersionProvider

Direct Known Subclasses:

AbstractFileVersionProvider

public abstract class AbstractVersionProvider
extends Object
implements VersionProvider

Base class for all VersionProvider implementations

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and 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 and Description
AbstractVersionProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract String	doGetVersion(Object target)
protected abstract void	doSetVersion(Object target, String version)
String	getVersion(Object target) Returns the current version
void	setDefaultValue(String defaultValue)
void	setVersion(Object target, 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 Detail

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 Detail

AbstractVersionProvider

public AbstractVersionProvider()

Method Detail

setDefaultValue

public void setDefaultValue(String defaultValue)

getVersion

public String getVersion(Object target)
                  throws UpgradeException

Description copied from interface: VersionProvider

Returns the current version

Specified by:

getVersion in interface VersionProvider

Parameters:

target - the target

Returns:

version number

Throws:

UpgradeException - if there is any error getting the current version

doGetVersion

protected abstract String doGetVersion(Object target)
                                throws Exception

Throws:

Exception

setVersion

public void setVersion(Object target,
                       String version)
                throws UpgradeException

Description copied from interface: VersionProvider

Updates the current version

Specified by:

setVersion in interface VersionProvider

Parameters:

target - the target

version - the new version

Throws:

UpgradeException - if there is any error setting the current version

doSetVersion

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

Throws:

Exception