Extension SDK 9.0.5

oracle.jdeveloper.vcs.spi
Class VCSDirectoryInvokable

java.lang.Object
  extended byoracle.jdeveloper.vcs.spi.VCSDirectoryInvokable

public abstract class VCSDirectoryInvokable
extends java.lang.Object

Class for assisting version clients with per-directory external command invocation.

Since:
9.0.5

Constructor Summary
VCSDirectoryInvokable(VCSDirectoryInvokableState state, int maxArguments)
          Constructor.
 
Method Summary
protected abstract  boolean doInvocation(java.net.URL parent, java.net.URL[] invokeUrlArgs)
          Performs an invocation for the given directory, and files.
 DeterminateProgressMonitor getProgressMonitor()
          Gets the progress monitor of the invokable instance.
 boolean runInvokable()
          Runs the invokable commands.
 void setProgressMonitor(DeterminateProgressMonitor monitor)
          Sets the progress monitor of the invokable instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VCSDirectoryInvokable

public VCSDirectoryInvokable(VCSDirectoryInvokableState state,
                             int maxArguments)
Constructor.

Parameters:
state - the state object on which to operate.
Method Detail

setProgressMonitor

public void setProgressMonitor(DeterminateProgressMonitor monitor)
Sets the progress monitor of the invokable instance.

Parameters:
monitor - the progress monitor.

getProgressMonitor

public DeterminateProgressMonitor getProgressMonitor()
Gets the progress monitor of the invokable instance.

Returns:
the progress monitor.

runInvokable

public boolean runInvokable()
                     throws java.lang.Exception
Runs the invokable commands.

Returns:
a verdict on whether invocations finished without cancellation.
Throws:
java.lang.Exception

doInvocation

protected abstract boolean doInvocation(java.net.URL parent,
                                        java.net.URL[] invokeUrlArgs)
                                 throws java.lang.Exception
Performs an invocation for the given directory, and files.

Parameters:
parent - the parent directory for the invocation.
invokeUrlArgs - the URL arguments for the invocation.
Returns:
a verdict on whether the invocation finished without cancellation.
Throws:
java.lang.Exception - if a critical exception occurred.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.