oracle.jdeveloper.vcs.generic

Class ActionCommand

java.lang.Object

oracle.ide.controller.Command

oracle.jdeveloper.vcs.spi.VCSCommand

oracle.jdeveloper.vcs.generic.ActionCommand

public abstract class ActionCommand
extends VCSCommand

Field Summary

Fields inherited from class oracle.jdeveloper.vcs.spi.VCSCommand

CANCEL, ERROR, NOOP, OK

Fields inherited from class oracle.ide.controller.Command

context, EXECUTING, MULTI_NODE, NO_CHANGE, NO_UNDO, NORMAL, type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionCommand(int cmdId)
protected	ActionCommand(int cmdId, int type)
protected	ActionCommand(int cmdId, int type, java.lang.String name)
protected	ActionCommand(java.lang.String commandId)
protected	ActionCommand(java.lang.String commandId, int type)
protected	ActionCommand(java.lang.String commandId, int type, java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureCommandState(CommandState commandState, VCSDirectoryInvokableState invokableState, java.util.Map timestamps, Locatable[] locatables)
protected CommandState	createCommandState()
protected oracle.bali.ewt.dialog.JEWTDialog	createOperationDialog(java.util.Collection nodes, VCSOptionsCustomizer customizer)
protected VCSOptionsCustomizer	createOptionsCustomizer()
protected VCSOptionsCustomizer	createOptionsCustomizer(java.util.Collection nodes)
protected int	doitImpl() Executes the actions associated with a specific version control command (implementation).
protected int	doitImpl(VCSProfile profile)
protected int	doitImplInvoke(VCSProfile profile, Locatable[] locatables)
protected java.lang.String	getActionId()
protected VCSActionInfo	getActionInfo()
protected CommandState	getCommandState(VCSProfile profile, Locatable[] locatables) Prepares a VCSCommandState for the ActionCommand based on the supplied context Locatables and VCSProfile.
protected java.lang.String	getDialogHint()
protected java.lang.String	getDialogTitle()
protected java.lang.String	getHelpTopicId()
protected Locatable[]	getOperands(VCSProfile profile) Retrieves the operable locatables for this ActionCommand.
protected oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus>	getPolicyStatusCache()
protected VCSProfile	getProfile()
protected VCSStatusCache	getStatusCache() Deprecated.
protected oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus>	getStatusCacheBridge()
protected URLFilter	getURLFilter() Gets the URL filter controlling locatables in the command context.
protected boolean	invokeCommand(VCSProfile profile, CommandState commandState)
protected boolean	invokeCommandImpl(VCSProfile profile, CommandState commandState, java.awt.Component parentUi, java.util.Map options)
protected boolean	invokeCommandSilently(VCSProfile profile, CommandState commandState)
protected boolean	invokeCommandSilentlyImpl(VCSProfile profile, CommandState commandState, java.util.Map options)
protected boolean	isAvailableImpl() Asks whether the command is available for the current context.
protected boolean	isAvailableImpl(VCSProfile profile)
protected boolean	isChangeListAction(View view, VCSProfile profile) Determines whether or not this action has originated from a ChangeList containing view.
protected boolean	isDialogRequired(ChangeListWindow changeListWindow, VCSProfile profile)
protected boolean	isSilent(Context context, VCSProfile profile) Determines whether or not the action should be invoked silently, i.e.
protected boolean	locatablesValid(VCSProfile profile)
protected void	postInvoke(VCSProfile profile, CommandState commandState) Handles housekeeping duties necessary after invocation of the command on the underlying vcs.
protected boolean	requirementsSatisfied(VCSProfile profile)
protected boolean	saveDirtyNodes(Locatable[] contextLocatables) Saves dirty nodes present among the Locatables from the current context.
protected void	setCommandSpecificCustomizerOptions(VCSProfile profile, VCSOptionsCustomizer customizer) Give implemening subclasses a chance to poke values into the customizer
void	setProfile(VCSProfile profile)

Methods inherited from class oracle.jdeveloper.vcs.spi.VCSCommand

buildContextForEditor, createStatusFilter, doit, fireFileStructureChanged, fireSomeFilesCreated, fireSomeFilesDeleted, getContextLocatables, getExceptionHandler, getExtension, getFilteredSelection, getFilteredSelection, getLocatableURLFilter, getStatusFilter, initializeCommandStyle, initializeCommandType, isAvailable, isAvailableImpl, isAvailableImpl, isAvailableImpl, isThreaded, noOp, noOpImpl, reloadBuffers, storeTimestamps, updateReadOnlyStates

Methods inherited from class oracle.ide.controller.Command

enableConfirmation, getAffectedNodes, getContext, getData, getId, getName, getProgressHandle, getType, isGlobal, setContext, setData, setTaskInfo, undo

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionCommand

protected ActionCommand(int cmdId)

ActionCommand

protected ActionCommand(int cmdId,
             int type)

ActionCommand

protected ActionCommand(int cmdId,
             int type,
             java.lang.String name)

ActionCommand

protected ActionCommand(java.lang.String commandId)

ActionCommand

protected ActionCommand(java.lang.String commandId,
             int type)

ActionCommand

protected ActionCommand(java.lang.String commandId,
             int type,
             java.lang.String name)

Method Detail

setProfile

public void setProfile(VCSProfile profile)

getActionId

protected java.lang.String getActionId()

getProfile

protected VCSProfile getProfile()

getActionInfo

protected VCSActionInfo getActionInfo()

getStatusCache

@Deprecated
protected VCSStatusCache getStatusCache()

Deprecated.

Description copied from class: VCSCommand

Gets the status cache for the VCS command.

Overrides:

getStatusCache in class VCSCommand

Returns:

the command's status cache.

getStatusCacheBridge

protected oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> getStatusCacheBridge()

Overrides:

getStatusCacheBridge in class VCSCommand

getPolicyStatusCache

protected oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus> getPolicyStatusCache()

Overrides:

getPolicyStatusCache in class VCSCommand

getURLFilter

protected URLFilter getURLFilter()

Description copied from class: VCSCommand

Gets the URL filter controlling locatables in the command context.

Overrides:

getURLFilter in class VCSCommand

Returns:

the command's URL filter.

isAvailableImpl

protected boolean isAvailableImpl()
                           throws java.lang.Exception

Description copied from class: VCSCommand

Asks whether the command is available for the current context.

Overrides:

isAvailableImpl in class VCSCommand

Returns:

true if the command style is VCSCommandStyle.NORMAL, otherwise calls VCSCommand.isAvailableImpl(Locatable[]) with contextual locatables.

Throws:

java.lang.Exception

isAvailableImpl

protected boolean isAvailableImpl(VCSProfile profile)
                           throws java.lang.Exception

Throws:

java.lang.Exception

requirementsSatisfied

protected boolean requirementsSatisfied(VCSProfile profile)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

locatablesValid

protected boolean locatablesValid(VCSProfile profile)

doitImpl

protected int doitImpl()
                throws java.lang.Exception

Description copied from class: VCSCommand

Executes the actions associated with a specific version control command (implementation).

Specified by:

doitImpl in class VCSCommand

Returns:

Command.OK, Command.CANCEL, VCSCommand.NOOP, VCSCommand.ERROR - or any negative value to indicate command failure.

Throws:

java.lang.Exception

doitImpl

protected int doitImpl(VCSProfile profile)
                throws java.lang.Exception

Throws:

java.lang.Exception

doitImplInvoke

protected int doitImplInvoke(VCSProfile profile,
                 Locatable[] locatables)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getOperands

protected Locatable[] getOperands(VCSProfile profile)
                           throws java.lang.Exception

Retrieves the operable locatables for this ActionCommand.

Parameters:

profile - the active VCSProfile.

Returns:

operable Locatables.

Throws:

java.lang.Exception

saveDirtyNodes

protected boolean saveDirtyNodes(Locatable[] contextLocatables)
                          throws java.lang.Exception

Saves dirty nodes present among the Locatables from the current context.

Parameters:

contextLocatables - the selected Locatables in the current context.

Returns:

true if dirty nodes were successfully saved, false if the save operation was cancelled by some event.

Throws:

java.lang.Exception

isSilent

protected boolean isSilent(Context context,
               VCSProfile profile)

Determines whether or not the action should be invoked silently, i.e. without extraneous ui. The determination is based on whether or not the originating view is a ChangeList containing view and also the change list's current dialog usage policy.

Parameters:

context - the originating Context.

profile - the active VCSProfile

Returns:

true if the action should proceed without extraneous ui, false otherwise.

isChangeListAction

protected boolean isChangeListAction(View view,
                         VCSProfile profile)

Determines whether or not this action has originated from a ChangeList containing view.

Returns:

true if this action has been invoked from a change list, false otherwise.

isDialogRequired

protected boolean isDialogRequired(ChangeListWindow changeListWindow,
                       VCSProfile profile)

getCommandState

protected CommandState getCommandState(VCSProfile profile,
                           Locatable[] locatables)
                                throws java.lang.Exception

Prepares a VCSCommandState for the ActionCommand based on the supplied context Locatables and VCSProfile.

Parameters:

profile - the active VCSProfile.

locatables - the Locatables in context.

Returns:

a CommandState for the ActionCommand, or null if there is no such state.

Throws:

java.lang.Exception

createCommandState

protected CommandState createCommandState()

configureCommandState

protected void configureCommandState(CommandState commandState,
                         VCSDirectoryInvokableState invokableState,
                         java.util.Map timestamps,
                         Locatable[] locatables)

invokeCommand

protected boolean invokeCommand(VCSProfile profile,
                    CommandState commandState)
                         throws java.lang.Exception

Throws:

java.lang.Exception

setCommandSpecificCustomizerOptions

protected void setCommandSpecificCustomizerOptions(VCSProfile profile,
                                       VCSOptionsCustomizer customizer)

Give implemening subclasses a chance to poke values into the customizer

createOptionsCustomizer

protected VCSOptionsCustomizer createOptionsCustomizer(java.util.Collection nodes)

createOptionsCustomizer

protected VCSOptionsCustomizer createOptionsCustomizer()

createOperationDialog

protected oracle.bali.ewt.dialog.JEWTDialog createOperationDialog(java.util.Collection nodes,
                                                      VCSOptionsCustomizer customizer)

getDialogTitle

protected java.lang.String getDialogTitle()

getDialogHint

protected java.lang.String getDialogHint()

getHelpTopicId

protected java.lang.String getHelpTopicId()

invokeCommandSilently

protected boolean invokeCommandSilently(VCSProfile profile,
                            CommandState commandState)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

invokeCommandImpl

protected boolean invokeCommandImpl(VCSProfile profile,
                        CommandState commandState,
                        java.awt.Component parentUi,
                        java.util.Map options)
                             throws java.lang.Exception

Throws:

java.lang.Exception

invokeCommandSilentlyImpl

protected boolean invokeCommandSilentlyImpl(VCSProfile profile,
                                CommandState commandState,
                                java.util.Map options)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

postInvoke

protected void postInvoke(VCSProfile profile,
              CommandState commandState)
                   throws java.lang.Exception

Handles housekeeping duties necessary after invocation of the command on the underlying vcs.

Parameters:

profile - the active VCSProfile.

commandState - the relevant CommandState.

Throws:

java.lang.Exception