info.magnolia.module.delta
Class NewPropertyTask

java.lang.Object
  info.magnolia.module.delta.AbstractTask
      info.magnolia.module.delta.PropertyValuesTask
          info.magnolia.module.delta.NewPropertyTask

All Implemented Interfaces:

Task

public class NewPropertyTask
extends PropertyValuesTask

Creates a new property. Outputs a warning if the property already exists.

Version:

$Revision: $ ($Author: $)

Author:

gjoseph

Field Summary

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

log

Constructor Summary

NewPropertyTask(java.lang.String name, java.lang.String description, java.lang.String workspaceName, java.lang.String nodePath, java.lang.String propertyName, java.lang.String value)

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

checkAndModifyPropertyValue, 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

NewPropertyTask

public NewPropertyTask(java.lang.String name,
                       java.lang.String description,
                       java.lang.String workspaceName,
                       java.lang.String nodePath,
                       java.lang.String propertyName,
                       java.lang.String value)

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