nl.toolforge.karma.core.cmd.impl
Class UpdateModuleCommand

java.lang.Object
  nl.toolforge.karma.core.cmd.DefaultCommand
      nl.toolforge.karma.core.cmd.impl.UpdateModuleCommand

All Implemented Interfaces:

Command

public class UpdateModuleCommand

extends DefaultCommand

This command updates a module on a developers' local system. When the module has not been updated before, the module will be checked out (this is transparent for the user). The syntax for this command is:

update-module -m, --module-name <module-name> [ -v <version-number> ]

The m option specifies the module that should be updated. The v option specifies a specific version that should be fetched. The v option implies that the module is updated to STATIC state, regardless of the configuration for the module in the manifest. This state can be revoked by updating the module without specifying the v option. Karma will apply pattern rules to determine the actual symbolic name that is used in the version control system for the version.

Version:

$Id: UpdateModuleCommand.java,v 1.56 2004/11/10 23:53:09 asmedes Exp $

Author:

D.A. Smedes

Field Summary

protected CommandResponse

response

Constructor Summary

UpdateModuleCommand(CommandDescriptor descriptor)
Creates a UpdateModuleCommand for module module that should be updated.

Method Summary

void	execute() This command will update the module from the version control system.
CommandResponse	getCommandResponse() Return the specific CommandResponse object that this command uses.

Methods inherited from class nl.toolforge.karma.core.cmd.DefaultCommand

cleanUp, deregisterCommandResponseListener, getAlias, getCommandLine, getContext, getDescription, getFrontendMessages, getHelp, getName, getResponseListener, getWorkingContext, registerCommandResponseListener, setCommandLine, setContext

Methods inherited from class java.lang.Object

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

Field Detail

response

protected CommandResponse response

Constructor Detail

UpdateModuleCommand

public UpdateModuleCommand(CommandDescriptor descriptor)

Creates a UpdateModuleCommand for module module that should be updated. This module requires an Option

Parameters:

descriptor - The command descriptor for this command.

Method Detail

execute

public void execute()
             throws CommandException

This command will update the module from the version control system. An update is done when the module is already present, otherwise a checkout will be performed. The checkout directory for the module is relative to the root directory of the active manifest.

Throws:

CommandException - When execution failed. This exception catches all underlying exceptions and rethrows them as a CommandException, except for RuntimeExceptions.

getCommandResponse

public CommandResponse getCommandResponse()

Description copied from interface: Command

Return the specific CommandResponse object that this command uses.

Returns:

CommandResponse