Eclipse Platform
Release 3.0

org.eclipse.update.standalone
Class UpdateCommand

java.lang.Object
  extended byorg.eclipse.update.standalone.ScriptedCommand
      extended byorg.eclipse.update.standalone.UpdateCommand
All Implemented Interfaces:
IOperationListener

public class UpdateCommand
extends ScriptedCommand

Command to update and existing feature.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:
3.0

Field Summary
 
Fields inherited from class org.eclipse.update.standalone.ScriptedCommand
verifyOnly
 
Constructor Summary
UpdateCommand(String featureId, String verifyOnly)
          Update command for updating a feature to a newer version.
UpdateCommand(String featureId, String version, String verifyOnly)
          Update command for updating a feature to a specified newer version.
 
Method Summary
 boolean run(IProgressMonitor monitor)
          Executes the command.
 
Methods inherited from class org.eclipse.update.standalone.ScriptedCommand
afterExecute, applyChangesNow, beforeExecute, getConfiguration, isVerifyOnly, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UpdateCommand

public UpdateCommand(String featureId,
                     String verifyOnly)
              throws Exception
Update command for updating a feature to a newer version.

Parameters:
featureId -
verifyOnly -
Throws:
Exception

UpdateCommand

public UpdateCommand(String featureId,
                     String version,
                     String verifyOnly)
              throws Exception
Update command for updating a feature to a specified newer version.

Parameters:
featureId -
version -
verifyOnly -
Throws:
Exception
Method Detail

run

public boolean run(IProgressMonitor monitor)
Description copied from class: ScriptedCommand
Executes the command. Subclasses are responsible for implementing this method. If the command was constructed with verifyOnly=true, the command should not execute, but only verify it can execute.

Specified by:
run in class ScriptedCommand
Parameters:
monitor - progress monitor during command execution.

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.