org.povclipse2.wizards.helper

Class ZipLeveledStructureProvider

java.lang.Object

org.povclipse2.wizards.helper.ZipLeveledStructureProvider

All Implemented Interfaces:

ILeveledImportStructureProvider

public class ZipLeveledStructureProvider
extends java.lang.Object
implements ILeveledImportStructureProvider

This class provides information regarding the context structure and content of specified zip file entry objects.

Since:

3.1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	closeArchive() Close the archive file that was used to create this leveled structure provider.
protected java.util.zip.ZipEntry	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<java.util.zip.ZipEntry>	getChildren(java.lang.Object element)
java.io.InputStream	getContents(java.lang.Object element)
java.lang.String	getFullPath(java.lang.Object element)
java.lang.String	getLabel(java.lang.Object element)
java.lang.Object	getRoot() Returns the entry that this importer uses as the root sentinel.
int	getStrip() Returns the number of directories that this IImportStructureProvider is stripping from the file name
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)
void	setStrip(int level) Tells the provider to strip N number of directories from the path of any path or file name returned by the IImportStructureProvider (Default=0).

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipLeveledStructureProvider

public ZipLeveledStructureProvider(java.util.zip.ZipFile sourceFile)

Creates a ZipFileStructureProvider, which will operate on the passed zip file.

Parameters:

sourceFile - The source file to create the ZipLeveledStructureProvider around

Method Detail

createContainer

protected java.util.zip.ZipEntry createContainer(IPath pathname)

Creates a new container zip entry with the specified name, iff it has not already been created. If the parent of the given element does not already exist it will be recursively created as well.

Parameters:

pathname - The path representing the container

Returns:

The element represented by this pathname (it may have already existed)

createFile

protected void createFile(java.util.zip.ZipEntry entry)

Creates a new file zip entry with the specified name.

getChildren

public java.util.List<java.util.zip.ZipEntry> getChildren(java.lang.Object element)

getContents

public java.io.InputStream getContents(java.lang.Object element)

getFullPath

public java.lang.String getFullPath(java.lang.Object element)

getLabel

public java.lang.String getLabel(java.lang.Object element)

getRoot

public java.lang.Object getRoot()

Returns the entry that this importer uses as the root sentinel.

Specified by:

getRoot in interface ILeveledImportStructureProvider

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

closeArchive

public boolean closeArchive()

Description copied from interface: ILeveledImportStructureProvider

Close the archive file that was used to create this leveled structure provider.

Specified by:

closeArchive in interface ILeveledImportStructureProvider

Returns:

true if the archive was closed successfully

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)

setStrip

public void setStrip(int level)

Description copied from interface: ILeveledImportStructureProvider

Tells the provider to strip N number of directories from the path of any path or file name returned by the IImportStructureProvider (Default=0).

Specified by:

setStrip in interface ILeveledImportStructureProvider

Parameters:

level - The number of directories to strip

getStrip

public int getStrip()

Description copied from interface: ILeveledImportStructureProvider

Returns the number of directories that this IImportStructureProvider is stripping from the file name

Specified by:

getStrip in interface ILeveledImportStructureProvider

Returns:

int Number of entries