public abstract class VCSDirectoryInvokable
extends java.lang.Object
Class for assisting version clients with per-directory external command invocation.
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_MILLIS_TO_DECIDE_TO_POPUP |
static int |
DEFAULT_MILLIS_TO_POPUP |
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. |
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.
|
public static final int DEFAULT_MILLIS_TO_DECIDE_TO_POPUP
public static final int DEFAULT_MILLIS_TO_POPUP
public VCSDirectoryInvokable(VCSInvokableState state, int maxArguments)
state
- the state object on which to operate.maxArguments
- public VCSDirectoryInvokable(VCSInvokableState state, int maxArguments, boolean ignoreSubdirs)
VCSDirectoryInvokable
instance for assisting
with per-directory external command invocation.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.public VCSInvokableState getState()
VCSDirectoryInvokableState
on which to operate.public void setProgressMonitor(DeterminateProgressMonitor monitor)
monitor
- the progress monitor.public DeterminateProgressMonitor getProgressMonitor()
public boolean runInvokable() throws java.lang.Exception
java.lang.Exception
protected void initializeProgressMonitor(DeterminateProgressMonitor monitor)
monitor
- the progress monitor.protected abstract boolean doInvocation(java.net.URL parent, java.net.URL[] invokeUrlArgs) throws java.lang.Exception
parent
- the parent directory for the invocation.invokeUrlArgs
- the URL arguments for the invocation.java.lang.Exception
- if a critical exception occurred.