info.magnolia.module.delta

Class CheckOrCreatePropertyTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.PropertyValuesTask

info.magnolia.module.delta.CheckOrCreatePropertyTask

All Implemented Interfaces:

Task

public class CheckOrCreatePropertyTask
extends PropertyValuesTask

Sets the specified property with a new value or creates the property with the new value.

Field Summary

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

DO_NOTHING, log

Constructor Summary

Constructors

Constructor and Description
CheckOrCreatePropertyTask(String name, String nodePath, String propertyName, String expectedValue)
CheckOrCreatePropertyTask(String name, String workspaceName, String nodePath, String propertyName, String expectedValue)
CheckOrCreatePropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, String expectedValue)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(InstallContext ctx) A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on.

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

checkAndModifyPartOfPropertyValue, checkAndModifyPropertyValue, checkAndModifyPropertyValue, checkAndModifyPropertyValue, checkOrCreateProperty, checkOrCreateProperty, format, format, format, newProperty, newProperty

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

Constructor Detail

CheckOrCreatePropertyTask

public CheckOrCreatePropertyTask(String name,
                         String nodePath,
                         String propertyName,
                         String expectedValue)

CheckOrCreatePropertyTask

public CheckOrCreatePropertyTask(String name,
                         String workspaceName,
                         String nodePath,
                         String propertyName,
                         String expectedValue)

CheckOrCreatePropertyTask

public CheckOrCreatePropertyTask(String name,
                         String description,
                         String workspaceName,
                         String nodePath,
                         String propertyName,
                         String expectedValue)

Method Detail

execute

public void execute(InstallContext ctx)
             throws TaskExecutionException

Description copied from interface: Task

A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on. The task could also potentially do backups of nodes it needs to modify extensively, so the user could refer to the backups in case of problem. In the event of an unrecoverable issue, the Task could also throw a TaskExecutionException, knowing that will cancel the whole module's installation, update and startup. If a TaskExecutionException must be thrown, keep in mind that the exception message will still be shown to the end user, so try to keep them human readable.

Throws:

TaskExecutionException