Class ZipFileStructureProvider
java.lang.Object
org.eclipse.ui.wizards.datatransfer.ZipFileStructureProvider
- All Implemented Interfaces:
IImportStructureProvider
This class provides information regarding the context structure and
content of specified zip file entry objects.
-
Constructor Summary
ConstructorDescriptionZipFileStructureProvider
(ZipFile sourceFile) Creates aZipFileStructureProvider
, which will operate on the passed zip file. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addToChildren
(ZipEntry parent, ZipEntry child) Adds the specified child to the internal collection of the parent's children.protected void
createContainer
(IPath pathname) Creates a new container zip entry with the specified name, iff it has not already been created.protected void
createFile
(ZipEntry entry) Creates a new file zip entry with the specified name.List<?>
getChildren
(Object element) Returns a collection with the children of the specified structured element.getContents
(Object element) Returns the contents of the specified structured element, ornull
if there is a problem determining the element's contents.getFullPath
(Object element) Returns the full path of the specified structured element.Returns the display label of the specified structured element.getRoot()
Returns the entry that this importer uses as the root sentinel.Returns the zip file that this provider provides structure for.protected void
Initializes this object's children table based on the contents of the specified source file.boolean
Returns a boolean indicating whether the passed structured element represents a container element (as opposed to a leaf element).
-
Constructor Details
-
ZipFileStructureProvider
Creates aZipFileStructureProvider
, which will operate on the passed zip file.- Parameters:
sourceFile
- the zip file used to create this structure provider
-
-
Method Details
-
addToChildren
Adds the specified child to the internal collection of the parent's children. -
createContainer
Creates a new container zip entry with the specified name, iff it has not already been created. -
createFile
Creates a new file zip entry with the specified name. -
getChildren
Description copied from interface:IImportStructureProvider
Returns a collection with the children of the specified structured element.- Specified by:
getChildren
in interfaceIImportStructureProvider
- Parameters:
element
- the element for which to compute the children- Returns:
- the list of child elements
-
getContents
Description copied from interface:IImportStructureProvider
Returns the contents of the specified structured element, ornull
if there is a problem determining the element's contents.Note:: The client is responsible for closing the stream when finished.
- Specified by:
getContents
in interfaceIImportStructureProvider
- Parameters:
element
- a structured element- Returns:
- the contents of the structured element, or
null
-
getFullPath
Description copied from interface:IImportStructureProvider
Returns the full path of the specified structured element.- Specified by:
getFullPath
in interfaceIImportStructureProvider
- Parameters:
element
- a structured element- Returns:
- the display label of the structured element
-
getLabel
Description copied from interface:IImportStructureProvider
Returns the display label of the specified structured element.- Specified by:
getLabel
in interfaceIImportStructureProvider
- Parameters:
element
- a structured element- Returns:
- the display label of the structured element
-
getRoot
Returns the entry that this importer uses as the root sentinel.- Returns:
- java.util.zip.ZipEntry
-
getZipFile
Returns the zip file that this provider provides structure for.- Returns:
- the zip file this provider provides structure for
-
initialize
protected void initialize()Initializes this object's children table based on the contents of the specified source file. -
isFolder
Description copied from interface:IImportStructureProvider
Returns a boolean indicating whether the passed structured element represents a container element (as opposed to a leaf element).- Specified by:
isFolder
in interfaceIImportStructureProvider
- Parameters:
element
- java.lang.Object- Returns:
- boolean
-