org.nuxeo.connect.update.task.standalone.commands

Class CompositeCommand

java.lang.Object

org.nuxeo.connect.update.task.standalone.commands.AbstractCommand

org.nuxeo.connect.update.task.standalone.commands.CompositeCommand

All Implemented Interfaces:

org.nuxeo.connect.update.task.Command

public class CompositeCommand
extends AbstractCommand

Command embedding multiple commands. For internal use.

Since:

5.5

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.nuxeo.connect.update.task.Command>	commands
static String	ID

Fields inherited from class org.nuxeo.connect.update.task.standalone.commands.AbstractCommand

fail, guardVars, id, ignore

Constructor Summary

Constructors

Modifier	Constructor and Description
	CompositeCommand()
protected	CompositeCommand(String id)

Method Summary

Modifier and Type	Method and Description
void	addCommand(org.nuxeo.connect.update.task.Command command)
CompositeCommand	combine(CompositeCommand cc)
protected org.nuxeo.connect.update.task.Command	doRun(org.nuxeo.connect.update.task.Task task, Map<String,String> prefs) Override to implement command actions
protected void	doValidate(org.nuxeo.connect.update.task.Task task, org.nuxeo.connect.update.ValidationStatus status) Override to implement validation.
boolean	isEmpty()
void	readFrom(Element element) Must be implemented to initialize the command arguments from an XML fragment.
void	writeTo(org.nuxeo.connect.update.xml.XmlWriter writer)

Methods inherited from class org.nuxeo.connect.update.task.standalone.commands.AbstractCommand

getId, ignore, initialize, isPostInstall, run, setFail, setIgnore, setPackageUpdateService, validate

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

commands

protected final List<org.nuxeo.connect.update.task.Command> commands

Constructor Detail

CompositeCommand

protected CompositeCommand(String id)

CompositeCommand

public CompositeCommand()

Method Detail

writeTo

public void writeTo(org.nuxeo.connect.update.xml.XmlWriter writer)

doRun

protected org.nuxeo.connect.update.task.Command doRun(org.nuxeo.connect.update.task.Task task,
                                                      Map<String,String> prefs)
                                               throws org.nuxeo.connect.update.PackageException

Description copied from class: AbstractCommand

Override to implement command actions

Specified by:

doRun in class AbstractCommand

Returns:

Rollback command

Throws:

org.nuxeo.connect.update.PackageException

doValidate

protected void doValidate(org.nuxeo.connect.update.task.Task task,
                          org.nuxeo.connect.update.ValidationStatus status)
                   throws org.nuxeo.connect.update.PackageException

Description copied from class: AbstractCommand

Override to implement validation.

Specified by:

doValidate in class AbstractCommand

Parameters:

task - The task being validated

status - Use ValidationStatus.addError(String) or ValidationStatus.addWarning(String) to provide validation error/warning messages

Throws:

org.nuxeo.connect.update.PackageException

readFrom

public void readFrom(Element element)
              throws org.nuxeo.connect.update.PackageException

Description copied from class: AbstractCommand

Must be implemented to initialize the command arguments from an XML fragment.

Specified by:

readFrom in class AbstractCommand

Throws:

org.nuxeo.connect.update.PackageException

addCommand

public void addCommand(org.nuxeo.connect.update.task.Command command)

isEmpty

public boolean isEmpty()

combine

public CompositeCommand combine(CompositeCommand cc)

Since:

9.3