Package org.craftercms.commons.upgrade

Interface VersionProvider<T>

Type Parameters:

T - The target type supported

All Known Implementing Classes:

AbstractFileVersionProvider, AbstractVersionProvider, YamlFileVersionProvider

public interface VersionProvider<T>

Provides the current version of a specific target

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SKIP	Value used when a file is missing from the repository
static final String	VERSION	Keyword used to retrieve the version

Method Summary

Modifier and Type	Method	Description
String	getVersion(UpgradeContext<T> context)	Returns the current version
void	setVersion(UpgradeContext<T> context, String version)	Updates the current version

Field Details

VERSION

static final String VERSION

Keyword used to retrieve the version

See Also:

• Constant Field Values

SKIP

static final String SKIP

Value used when a file is missing from the repository

See Also:

• Constant Field Values

Method Details

getVersion

String getVersion(UpgradeContext<T> context)
           throws UpgradeException

Returns the current version

Parameters:

context - the upgrade context

Returns:

version number

Throws:

UpgradeException - if there is any error getting the current version

setVersion

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

Updates the current version

Parameters:

context - the upgrade context

version - the new version

Throws:

UpgradeException - if there is any error setting the current version