Package org.eclipse.ui.wizards.datatransfer

Class ZipFileStructureProvider

  • All Implemented Interfaces:
    IImportStructureProvider
    public class ZipFileStructureProvider
extends java.lang.Object
implements IImportStructureProvider
    This class provides information regarding the context structure and content of specified zip file entry objects.

    • Constructor Summary

      Constructors 
      Constructor Description
      ZipFileStructureProvider​(java.util.zip.ZipFile sourceFile)
      Creates a ZipFileStructureProvider, which will operate on the passed zip file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addToChildren​(java.util.zip.ZipEntry parent, java.util.zip.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​(java.util.zip.ZipEntry entry)
      Creates a new file zip entry with the specified name.
      java.util.List<?> getChildren​(java.lang.Object element)
      Returns a collection with the children of the specified structured element.
      java.io.InputStream getContents​(java.lang.Object element)
      Returns the contents of the specified structured element, or null if there is a problem determining the element's contents.
      java.lang.String getFullPath​(java.lang.Object element)
      Returns the full path of the specified structured element.
      java.lang.String getLabel​(java.lang.Object element)
      Returns the display label of the specified structured element.
      java.util.zip.ZipEntry getRoot()
      Returns the entry that this importer uses as the root sentinel.
      java.util.zip.ZipFile getZipFile()
      Returns the zip file that this provider provides structure for.
      protected void initialize()
      Initializes this object's children table based on the contents of the specified source file.
      boolean isFolder​(java.lang.Object element)
      Returns a boolean indicating whether the passed structured element represents a container element (as opposed to a leaf element).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ZipFileStructureProvider

        public ZipFileStructureProvider​(java.util.zip.ZipFile sourceFile)
        Creates a ZipFileStructureProvider, which will operate on the passed zip file.
        Parameters:
        sourceFile - the zip file used to create this structure provider

    • Method Detail

      • addToChildren

        protected void addToChildren​(java.util.zip.ZipEntry parent,
                             java.util.zip.ZipEntry child)
        Adds the specified child to the internal collection of the parent's children.

      • createContainer

        protected void createContainer​(IPath pathname)
        Creates a new container zip entry with the specified name, iff it has not already been created.

      • createFile

        protected void createFile​(java.util.zip.ZipEntry entry)
        Creates a new file zip entry with the specified name.

      • getChildren

        public java.util.List<?> getChildren​(java.lang.Object element)
        Description copied from interface: IImportStructureProvider
        Returns a collection with the children of the specified structured element.
        Specified by:
        getChildren in interface IImportStructureProvider
        Parameters:
        element - the element for which to compute the children
        Returns:
        the list of child elements

      • getContents

        public java.io.InputStream getContents​(java.lang.Object element)
        Description copied from interface: IImportStructureProvider
        Returns the contents of the specified structured element, or null 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 interface IImportStructureProvider
        Parameters:
        element - a structured element
        Returns:
        the contents of the structured element, or null

      • getFullPath

        public java.lang.String getFullPath​(java.lang.Object element)
        Description copied from interface: IImportStructureProvider
        Returns the full path of the specified structured element.
        Specified by:
        getFullPath in interface IImportStructureProvider
        Parameters:
        element - a structured element
        Returns:
        the display label of the structured element

      • getLabel

        public java.lang.String getLabel​(java.lang.Object element)
        Description copied from interface: IImportStructureProvider
        Returns the display label of the specified structured element.
        Specified by:
        getLabel in interface IImportStructureProvider
        Parameters:
        element - a structured element
        Returns:
        the display label of the structured element

      • getRoot

        public java.util.zip.ZipEntry getRoot()
        Returns the entry that this importer uses as the root sentinel.
        Returns:
        java.util.zip.ZipEntry

      • getZipFile

        public java.util.zip.ZipFile 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

        public boolean isFolder​(java.lang.Object element)
        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 interface IImportStructureProvider
        Parameters:
        element - java.lang.Object
        Returns:
        boolean