Package org.craftercms.studio.impl.v2.upgrade.operations.file

Class TemplateRenameUpgradeOperation

java.lang.Object

org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation<String>

org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

org.craftercms.studio.impl.v2.upgrade.operations.file.RenameUpgradeOperation

org.craftercms.studio.impl.v2.upgrade.operations.file.TemplateRenameUpgradeOperation

All Implemented Interfaces:

org.craftercms.commons.upgrade.UpgradeOperation<String>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

public class TemplateRenameUpgradeOperation
extends RenameUpgradeOperation

Extension of RenameUpgradeOperation that can rename multiple files based on path patterns

Supported YAML properties:

• basePath: (optional) relative path to search matches in the site

Since:

3.1.7

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	basePath	Relative path to search matches in the site
static String	CONFIG_KEY_BASE_PATH

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.operations.file.RenameUpgradeOperation

CONFIG_KEY_NEW_PATH, CONFIG_KEY_OLD_PATH, CONFIG_KEY_OVERWRITE, newPath, oldPath, overwrite

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

changedFiles, commitDetails, CONFIG_KEY_COMMIT_DETAILS, deletedFiles, servletContext, studioConfiguration

Fields inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

applicationContext, currentVersion, enabled, nextVersion

Constructor Summary

Constructors

Constructor	Description
TemplateRenameUpgradeOperation(StudioConfiguration studioConfiguration, DataSource dataSource)

Method Summary

Modifier and Type	Method	Description
void	doExecute(StudioUpgradeContext context)
void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.operations.file.RenameUpgradeOperation

renamePath

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

commitAllChanges, doExecute, getCommitMessage, init, loadResource, setServletContext, trackChangedFiles, trackDeletedFiles

Methods inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

execute, setApplicationContext, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_BASE_PATH

public static final String CONFIG_KEY_BASE_PATH

See Also:

Constant Field Values

basePath

protected String basePath

Relative path to search matches in the site

Constructor Detail

TemplateRenameUpgradeOperation

public TemplateRenameUpgradeOperation(StudioConfiguration studioConfiguration,
                                      DataSource dataSource)

Method Detail

doInit

public void doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)

Description copied from class: RenameUpgradeOperation

Overrides:

doInit in class RenameUpgradeOperation

doExecute

public void doExecute(StudioUpgradeContext context)
               throws org.craftercms.commons.upgrade.exception.UpgradeException

Overrides:

doExecute in class RenameUpgradeOperation

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException