info.magnolia.i18nsystem.setup

Class AbstractRemoveHardcodedI18nPropertiesTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.AbstractRepositoryTask

info.magnolia.i18nsystem.setup.AbstractRemoveHardcodedI18nPropertiesTask

All Implemented Interfaces:

info.magnolia.module.delta.Task

Direct Known Subclasses:

RemoveHardcodedI18nPropertiesFromDialogsTask, RemoveHardcodedI18nPropertiesFromSubappsTask

public abstract class AbstractRemoveHardcodedI18nPropertiesTask
extends info.magnolia.module.delta.AbstractRepositoryTask

Removes some well-known deprecated i18n properties whose keys are now generated via the I18nizer mechanism. The properties are defined by DEPRECATED_I18N_PROPERTIES.

Subclasses will need to implement getAppRelativePaths() to provide the paths relative to the module name under which one wants to remove such properties. All sub nodes under the provided paths will be searched recursively for the deprecated i18n properties.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DEPRECATED_I18N_PROPERTIES

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
AbstractRemoveHardcodedI18nPropertiesTask(String appName, String description)
AbstractRemoveHardcodedI18nPropertiesTask(String appName, String description, List<String> additionalDeprecatedProperties)

Method Summary

Modifier and Type	Method and Description
void	doExecute(info.magnolia.module.InstallContext installContext)
protected abstract String[]	getAppRelativePaths() Subclasses will need to implement this abstract method to provide the paths relative to the module name under which one wants to remove such properties.

Methods inherited from class info.magnolia.module.delta.AbstractRepositoryTask

execute

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEPRECATED_I18N_PROPERTIES

public static final List<String> DEPRECATED_I18N_PROPERTIES

Constructor Detail

AbstractRemoveHardcodedI18nPropertiesTask

public AbstractRemoveHardcodedI18nPropertiesTask(String appName,
                                                 String description)

AbstractRemoveHardcodedI18nPropertiesTask

public AbstractRemoveHardcodedI18nPropertiesTask(String appName,
                                                 String description,
                                                 List<String> additionalDeprecatedProperties)

Method Detail

doExecute

public void doExecute(info.magnolia.module.InstallContext installContext)
               throws javax.jcr.RepositoryException,
                      info.magnolia.module.delta.TaskExecutionException

Specified by:

doExecute in class info.magnolia.module.delta.AbstractRepositoryTask

Throws:

javax.jcr.RepositoryException

info.magnolia.module.delta.TaskExecutionException

getAppRelativePaths

protected abstract String[] getAppRelativePaths()

Subclasses will need to implement this abstract method to provide the paths relative to the module name under which one wants to remove such properties.
All sub nodes under the provided paths will be searched recursively for the deprecated i18n properties.