oracle.jdeveloper.vcs.spi

Class VCSDirectoryInvokable

java.lang.Object

oracle.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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MILLIS_TO_DECIDE_TO_POPUP
static int	DEFAULT_MILLIS_TO_POPUP

Constructor Summary

Constructors

Constructor and Description
VCSDirectoryInvokable(VCSInvokableState state, int maxArguments) Constructor.
VCSDirectoryInvokable(VCSInvokableState state, int maxArguments, boolean ignoreSubdirs) Constructs a new VCSDirectoryInvokable instance for assisting with per-directory external command invocation.

Method Summary

Modifier and Type	Method and Description
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.
VCSInvokableState	getState() Gets the invokable's state object.
protected void	initializeProgressMonitor(DeterminateProgressMonitor monitor) Initializes the given progress monitor.
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

Field Detail

DEFAULT_MILLIS_TO_DECIDE_TO_POPUP

public static final int DEFAULT_MILLIS_TO_DECIDE_TO_POPUP

See Also:

Constant Field Values

DEFAULT_MILLIS_TO_POPUP

public static final int DEFAULT_MILLIS_TO_POPUP

See Also:

Constant Field Values

Constructor Detail

VCSDirectoryInvokable

public VCSDirectoryInvokable(VCSInvokableState state,
                             int maxArguments)

Constructor.

Parameters:

state - the state object on which to operate.

maxArguments -

VCSDirectoryInvokable

public VCSDirectoryInvokable(VCSInvokableState state,
                             int maxArguments,
                             boolean ignoreSubdirs)

Constructs a new VCSDirectoryInvokable instance for assisting with per-directory external command invocation.

Parameters:

state - the VCSDirectoryInvokableState on which to operate.

maxArguments -

ignoreSubdirs - an indication as to whether or not subdirectories should be considered as entities in their own right for versioning operations.

Method Detail

getState

public VCSInvokableState getState()

Gets the invokable's state object.

Returns:

the VCSDirectoryInvokableState on which to operate.

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

initializeProgressMonitor

protected void initializeProgressMonitor(DeterminateProgressMonitor monitor)

Initializes the given progress monitor. By default, the progress monitor is configured with 500 as the 'MillisToDecideToPopup' value and 2000 as the 'MillisToPopup' value.

Parameters:

monitor - the progress monitor.

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.