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

Class XmlStreamVersionProvider

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.XmlStreamVersionProvider

All Implemented Interfaces:

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

public class XmlStreamVersionProvider
extends XmlFileVersionProvider

Extension of XmlFileVersionProvider that consumes a XMLEventReader in order to stop reading the XML once the version tag has been found.

Field Summary

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
XmlStreamVersionProvider(String path, String xpath, String defaultVersion, ContentRepository contentRepository, String versionElementName)

Method Summary

Modifier and Type	Method	Description
protected String	getVersionFromFile(String site, String filePath)	Get the version from the XML file.

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

doGetVersion, doSetVersion, 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

Constructor Details

XmlStreamVersionProvider

@ConstructorProperties({"path","xpath","defaultVersion","contentRepository","versionElementName"})
public XmlStreamVersionProvider(String path,
 String xpath,
 String defaultVersion,
 ContentRepository contentRepository,
 String versionElementName)

Method Details

getVersionFromFile

protected String getVersionFromFile(String site,
 String filePath)
                             throws Exception

Description copied from class: XmlFileVersionProvider

Get the version from the XML file. This method assumes the file existence has been checked previously.

Overrides:

getVersionFromFile in class XmlFileVersionProvider

Parameters:

site - Site name

filePath - Path of the file containing the version

Returns:

the version of the file, as found in the XML file <version> tag

Throws:

Exception