Package org.craftercms.studio.impl.v2.upgrade.providers

Class SiteVersionProvider

java.lang.Object

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

org.craftercms.studio.impl.v2.upgrade.providers.XmlFileVersionProvider

org.craftercms.studio.impl.v2.upgrade.providers.SiteVersionProvider

All Implemented Interfaces:

org.craftercms.commons.upgrade.VersionProvider<String>

public class SiteVersionProvider
extends XmlFileVersionProvider

Extension of XmlFileVersionProvider that also creates the version file if missing.

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.core.io.Resource	defaultFile	Path of the default file.

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.providers.XmlFileVersionProvider

contentRepository, defaultVersion, path, skipIfMissing, xpath

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
SiteVersionProvider(String path, String xpath, String defaultVersion, ContentRepository contentRepository, org.springframework.core.io.Resource defaultFile)

Method Summary

Modifier and Type	Method	Description
protected void	doSetVersion(org.craftercms.commons.upgrade.impl.UpgradeContext<String> context, String newVersion)

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.providers.XmlFileVersionProvider

doGetVersion, getFilePath, setPath, setSkipIfMissing

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

Field Detail

defaultFile

protected org.springframework.core.io.Resource defaultFile

Path of the default file.

Constructor Detail

SiteVersionProvider

@ConstructorProperties({"path","xpath","defaultVersion","contentRepository","defaultFile"})
public SiteVersionProvider(String path,
                           String xpath,
                           String defaultVersion,
                           ContentRepository contentRepository,
                           org.springframework.core.io.Resource defaultFile)

Method Detail

doSetVersion

protected void doSetVersion(org.craftercms.commons.upgrade.impl.UpgradeContext<String> context,
                            String newVersion)
                     throws Exception

Overrides:

doSetVersion in class XmlFileVersionProvider

Throws:

Exception