org.apache.commons.vfs2.provider.zip

Class ZipFileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.provider.zip.ZipFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, FileSystem, VfsComponent

Direct Known Subclasses:

JarFileSystem

public class ZipFileSystem
extends AbstractFileSystem

A read-only file system for ZIP and JAR files.

Constructor Summary

Constructors

Constructor and Description
ZipFileSystem(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	addCapabilities(Collection<Capability> caps) Returns the capabilities of this file system.
protected FileObject	createFile(AbstractFileName name) Creates a file object.
protected ZipFile	createZipFile(File file) Creates a Zip file.
protected ZipFileObject	createZipFileObject(AbstractFileName fileName, ZipEntry entry) Creates a new Zip file object.
protected void	doCloseCommunicationLink() Closes the underlying link used to access the files.
protected Charset	getCharset() Gets the Charset, defaults to StandardCharsets.UTF_8, the value used in ZipFile.
protected FileObject	getFileFromCache(FileName name) Gets a cached file.
protected ZipFile	getZipFile() Gets the zip file.
void	init() Initializes this component.
protected void	putFileToCache(FileObject file) Adds a file object to the cache.
protected void	removeFileFromCache(FileName name) remove a cached file.
String	toString()

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileSystem

addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, isOpen, isReleaseable, notifyAllStreamsClosed, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, setContext, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileSystem

public ZipFileSystem(AbstractFileName rootFileName,
                     FileObject parentLayer,
                     FileSystemOptions fileSystemOptions)
              throws FileSystemException

Constructs a new instance.

Parameters:

rootFileName - The root file name of this file system.

parentLayer - The parent layer of this file system.

fileSystemOptions - Options to build this file system.

Throws:

FileSystemException - If the parent layer does not exist, or on error replicating the file.

Method Detail

addCapabilities

protected void addCapabilities(Collection<Capability> caps)

Returns the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

createFile

protected FileObject createFile(AbstractFileName name)
                         throws FileSystemException

Creates a file object.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

FileSystemException

createZipFile

protected ZipFile createZipFile(File file)
                         throws FileSystemException

Creates a Zip file.

Parameters:

file - the underlying file.

Returns:

a Zip file.

Throws:

FileSystemException - if a file system error occurs.

createZipFileObject

protected ZipFileObject createZipFileObject(AbstractFileName fileName,
                                            ZipEntry entry)
                                     throws FileSystemException

Creates a new Zip file object.

Parameters:

fileName - the underlying file.

entry - the Zip entry.

Returns:

a new ZipFileObject.

Throws:

FileSystemException - if a file system error occurs.

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Closes the underlying link used to access the files.

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

getCharset

protected Charset getCharset()

Gets the Charset, defaults to StandardCharsets.UTF_8, the value used in ZipFile.

Returns:

the Charset.

getFileFromCache

protected FileObject getFileFromCache(FileName name)

Gets a cached file.

Overrides:

getFileFromCache in class AbstractFileSystem

Parameters:

name - name to search for.

Returns:

file object or null if not found.

getZipFile

protected ZipFile getZipFile()
                      throws FileSystemException

Gets the zip file.

Returns:

the zip file.

Throws:

FileSystemException - if a file system error occurs.

init

public void init()
          throws FileSystemException

Description copied from class: AbstractFileSystem

Initializes this component.

Specified by:

init in interface VfsComponent

Overrides:

init in class AbstractFileSystem

Throws:

FileSystemException - if an error occurs.

putFileToCache

protected void putFileToCache(FileObject file)

Adds a file object to the cache.

Overrides:

putFileToCache in class AbstractFileSystem

Parameters:

file - the file to add.

removeFileFromCache

protected void removeFileFromCache(FileName name)

remove a cached file.

Overrides:

removeFileFromCache in class AbstractFileSystem

Parameters:

name - The file name to remove.

toString

public String toString()

Overrides:

toString in class Object