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

Class XmlFileVersionProvider

java.lang.Object

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

All Implemented Interfaces:

VersionProvider

public class XmlFileVersionProvider
extends Object
implements VersionProvider

Implementation of for XML files.

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentRepository	contentRepository
protected String	defaultVersion Version returned if none is found.
protected String	path Path of the file containing the version.
protected String	site Name of the site.
protected boolean	skipIfMissing Indicates if the skip flag should be returned
protected String	xpath XPath expression to extract the version.

Fields inherited from interface org.craftercms.studio.api.v2.upgrade.VersionProvider

SKIP

Constructor Summary

Constructors

Constructor and Description
XmlFileVersionProvider(String site, String path)

Method Summary

Modifier and Type	Method and Description
String	getCurrentVersion() Returns the current version.
void	setContentRepository(ContentRepository contentRepository)
void	setDefaultVersion(String defaultVersion)
void	setPath(String path)
void	setSite(String site)
void	setSkipIfMissing(boolean skipIfMissing)
void	setXpath(String xpath)

Methods inherited from class java.lang.Object

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

Field Detail

site

protected String site

Name of the site.

path

protected String path

Path of the file containing the version.

xpath

protected String xpath

XPath expression to extract the version.

defaultVersion

protected String defaultVersion

Version returned if none is found.

skipIfMissing

protected boolean skipIfMissing

Indicates if the skip flag should be returned

contentRepository

protected ContentRepository contentRepository

Constructor Detail

XmlFileVersionProvider

public XmlFileVersionProvider(String site,
                              String path)

Method Detail

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setSite

public void setSite(String site)

setPath

public void setPath(String path)

setXpath

public void setXpath(String xpath)

setDefaultVersion

public void setDefaultVersion(String defaultVersion)

setSkipIfMissing

public void setSkipIfMissing(boolean skipIfMissing)

getCurrentVersion

public String getCurrentVersion()
                         throws UpgradeException

Returns the current version.

Specified by:

getCurrentVersion in interface VersionProvider

Returns:

version number

Throws:

UpgradeException - if there is any error getting the current version