public class ImportOperation extends WorkspaceModifyOperation
This class may be instantiated; it is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
protected IOverwriteQuery |
overwriteCallback |
Constructor and Description |
---|
ImportOperation(IPath containerPath,
IImportStructureProvider provider,
IOverwriteQuery overwriteImplementor,
List filesToImport)
Creates a new operation that imports specific file system objects.
|
ImportOperation(IPath containerPath,
Object source,
IImportStructureProvider provider,
IOverwriteQuery overwriteImplementor)
Creates a new operation that recursively imports the entire contents of the
specified root file system object.
|
ImportOperation(IPath containerPath,
Object source,
IImportStructureProvider provider,
IOverwriteQuery overwriteImplementor,
List filesToImport)
Creates a new operation that imports specific file system objects.
|
Modifier and Type | Method and Description |
---|---|
protected void |
execute(IProgressMonitor progressMonitor)
Performs the steps that are to be treated as a single logical workspace
change.
|
IStatus |
getStatus()
Returns the status of the import operation.
|
void |
setContext(Shell shell)
Sets the context for use by the VCM provider to prompt the user
for check-out of files.
|
void |
setCreateContainerStructure(boolean value)
Sets whether the containment structures that are implied from the full paths
of file system objects being imported should be duplicated in the workbench.
|
void |
setCreateLinks(boolean links)
Set Whether links will be created instead of files and folders
|
void |
setFilesToImport(List filesToImport)
Sets the file system objects to import.
|
void |
setOverwriteResources(boolean value)
Sets whether imported file system objects should automatically overwrite
existing workbench resources when a conflict occurs.
|
void |
setRelativeVariable(String variable)
Set a variable relative to which the links are created
|
void |
setVirtualFolders(boolean virtualFolders)
Set Whether groups and links will be created instead of files and folders
|
getRule, run, threadChange
protected IOverwriteQuery overwriteCallback
public ImportOperation(IPath containerPath, Object source, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor)
The source
parameter represents the root file system object to
import. All contents of this object are imported. Valid types for this parameter
are determined by the supplied IImportStructureProvider
.
The provider
parameter allows this operation to deal with the
source object in an abstract way. This operation calls methods on the provider
and the provider in turn calls specific methods on the source object.
The default import behavior is to recreate the complete container structure
for the contents of the root file system object in their destination.
If setCreateContainerStructure
is set to false then the container
structure created is relative to the root file system object.
containerPath
- the full path of the destination container within the
workspacesource
- the root file system object to importprovider
- the file system structure provider to useoverwriteImplementor
- the overwrite strategy to usepublic ImportOperation(IPath containerPath, Object source, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor, List filesToImport)
The source
parameter represents the root file system object to
import. Valid types for this parameter are determined by the supplied
IImportStructureProvider
. The contents of the source which
are to be imported are specified in the filesToImport
parameter.
The provider
parameter allows this operation to deal with the
source object in an abstract way. This operation calls methods on the provider
and the provider in turn calls specific methods on the source object.
The filesToImport
parameter specifies what contents of the root
file system object are to be imported.
The default import behavior is to recreate the complete container structure
for the file system objects in their destination. If setCreateContainerStructure
is set to false
, then the container structure created for each of
the file system objects is relative to the supplied root file system object.
containerPath
- the full path of the destination container within the
workspacesource
- the root file system object to import fromprovider
- the file system structure provider to useoverwriteImplementor
- the overwrite strategy to usefilesToImport
- the list of file system objects to be imported
(element type: Object
)public ImportOperation(IPath containerPath, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor, List filesToImport)
The provider
parameter allows this operation to deal with the
source object in an abstract way. This operation calls methods on the provider
and the provider in turn calls specific methods on the source object.
The filesToImport
parameter specifies what file system objects
are to be imported.
The default import behavior is to recreate the complete container structure
for the file system objects in their destination. If setCreateContainerStructure
is set to false
, then no container structure is created for each of
the file system objects.
containerPath
- the full path of the destination container within the
workspaceprovider
- the file system structure provider to useoverwriteImplementor
- the overwrite strategy to usefilesToImport
- the list of file system objects to be imported
(element type: Object
)protected void execute(IProgressMonitor progressMonitor)
WorkspaceModifyOperation
Subclasses must implement this method.
execute
in class WorkspaceModifyOperation
progressMonitor
- the progress monitor to use to display progress and field
user requests to cancelpublic IStatus getStatus()
OK
.public void setContext(Shell shell)
shell
- context for use by the VCM provider to prompt user
for check-out. The user will not be prompted if set to null
.IWorkspace.validateEdit(org.eclipse.core.resources.IFile[], java.lang.Object)
public void setCreateContainerStructure(boolean value)
value
- true
if containers should be created, and
false
otherwisepublic void setFilesToImport(List filesToImport)
filesToImport
- the list of file system objects to be imported
(element type: Object
)public void setOverwriteResources(boolean value)
value
- true
to automatically overwrite, and
false
otherwisepublic void setVirtualFolders(boolean virtualFolders)
virtualFolders
- public void setCreateLinks(boolean links)
links
- public void setRelativeVariable(String variable)
variable
-
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.