info.magnolia.module.delta
Class CheckAndModifyPropertyValueTask

java.lang.Object
  extended by info.magnolia.module.delta.AbstractTask
      extended by info.magnolia.module.delta.PropertyValuesTask
          extended by info.magnolia.module.delta.CheckAndModifyPropertyValueTask
All Implemented Interfaces:
Task

public class CheckAndModifyPropertyValueTask
extends PropertyValuesTask

If the specified property (NodeData) has the expected value, then it will be replaced by the new value.


Field Summary
 
Fields inherited from class info.magnolia.module.delta.AbstractTask
DO_NOTHING, log
 
Constructor Summary
CheckAndModifyPropertyValueTask(String workspaceName, String nodePath, String propertyName, Collection<String> expectedCurrentValues, String newValue)
           
CheckAndModifyPropertyValueTask(String nodePath, String propertyName, String expectedCurrentValue, String newValue)
           
CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, Collection<String> expectedCurrentValues, String newValue)
           
CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, String expectedCurrentValue, String newValue)
           
 
Method Summary
 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

CheckAndModifyPropertyValueTask

public CheckAndModifyPropertyValueTask(String nodePath,
                                       String propertyName,
                                       String expectedCurrentValue,
                                       String newValue)

CheckAndModifyPropertyValueTask

public CheckAndModifyPropertyValueTask(String workspaceName,
                                       String nodePath,
                                       String propertyName,
                                       Collection<String> expectedCurrentValues,
                                       String newValue)

CheckAndModifyPropertyValueTask

public CheckAndModifyPropertyValueTask(String name,
                                       String description,
                                       String workspaceName,
                                       String nodePath,
                                       String propertyName,
                                       String expectedCurrentValue,
                                       String newValue)

CheckAndModifyPropertyValueTask

public CheckAndModifyPropertyValueTask(String name,
                                       String description,
                                       String workspaceName,
                                       String nodePath,
                                       String propertyName,
                                       Collection<String> expectedCurrentValues,
                                       String newValue)
Method Detail

execute

public void execute(InstallContext ctx)
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.



Copyright © 2003-2014 Magnolia International Ltd.. All Rights Reserved.