org.apache.commons.vfs2.provider.zip

Class ZipFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

org.apache.commons.vfs2.provider.zip.ZipFileObject

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<org.apache.commons.vfs2.FileObject>, java.lang.Iterable<org.apache.commons.vfs2.FileObject>, org.apache.commons.vfs2.FileObject

Direct Known Subclasses:

JarFileObject

public class ZipFileObject
extends org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

A file in a Zip file system.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.zip.ZipEntry	entry The ZipEntry.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ZipFileObject(AbstractFileName name, java.util.zip.ZipEntry entry, org.apache.commons.vfs2.provider.zip.ZipFileSystem fs, boolean zipExists)

Method Summary

Modifier and Type	Method and Description
void	attachChild(org.apache.commons.vfs2.FileName childName) Attaches a child.
protected long	doGetContentSize() Returns the size of the file content (in bytes).
protected java.io.InputStream	doGetInputStream() Creates an input stream to read the file content from.
protected long	doGetLastModifiedTime() Returns the last modified time of this file.
protected org.apache.commons.vfs2.FileType	doGetType() Returns the file's type.
protected java.lang.String[]	doListChildren() Lists the children of the file.
boolean	isWriteable() Determines if this file can be written to.
protected void	setZipEntry(java.util.zip.ZipEntry entry) Sets the details for this file object.

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

canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doCreateFolder, doDelete, doDetach, doGetAttributes, doGetCertificates, doGetOutputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

entry

protected java.util.zip.ZipEntry entry

The ZipEntry.

Constructor Detail

ZipFileObject

protected ZipFileObject(AbstractFileName name,
                        java.util.zip.ZipEntry entry,
                        org.apache.commons.vfs2.provider.zip.ZipFileSystem fs,
                        boolean zipExists)
                 throws org.apache.commons.vfs2.FileSystemException

Throws:

org.apache.commons.vfs2.FileSystemException

Method Detail

setZipEntry

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

Sets the details for this file object.

Parameters:

entry - ZIP information related to this file.

attachChild

public void attachChild(org.apache.commons.vfs2.FileName childName)

Attaches a child.

Shouldn't this method have package-only visibility? Cannot change this without breaking binary compatibility.

Parameters:

childName - The name of the child.

isWriteable

public boolean isWriteable()
                    throws org.apache.commons.vfs2.FileSystemException

Determines if this file can be written to.

Specified by:

isWriteable in interface org.apache.commons.vfs2.FileObject

Overrides:

isWriteable in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

Returns:

true if this file is writeable, false if not.

Throws:

org.apache.commons.vfs2.FileSystemException - if an error occurs.

doGetType

protected org.apache.commons.vfs2.FileType doGetType()

Returns the file's type.

Specified by:

doGetType in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

doListChildren

protected java.lang.String[] doListChildren()

Lists the children of the file.

Specified by:

doListChildren in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

doGetContentSize

protected long doGetContentSize()

Returns the size of the file content (in bytes). Is only called if doGetType() returns FileType.FILE.

Specified by:

doGetContentSize in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws java.lang.Exception

Returns the last modified time of this file.

Overrides:

doGetLastModifiedTime in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

Throws:

java.lang.Exception

doGetInputStream

protected java.io.InputStream doGetInputStream()
                                        throws java.lang.Exception

Creates an input stream to read the file content from. Is only called if doGetType() returns FileType.FILE. The input stream returned by this method is guaranteed to be closed before this method is called again.

Specified by:

doGetInputStream in class org.apache.commons.vfs2.provider.AbstractFileObject<org.apache.commons.vfs2.provider.zip.ZipFileSystem>

Throws:

java.lang.Exception