org.apache.commons.vfs2.provider.gzip

Class GzipFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<FS>

org.apache.commons.vfs2.provider.compressed.CompressedFileFileObject<GzipFileSystem>

org.apache.commons.vfs2.provider.gzip.GzipFileObject

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<FileObject>, Iterable<FileObject>, FileObject

public class GzipFileObject
extends CompressedFileFileObject<GzipFileSystem>

A Gzip file.

Field Summary

Fields inherited from class org.apache.commons.vfs2.provider.compressed.CompressedFileFileObject

SIZE_UNDEFINED

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

DEFAULT_BUFFER_SIZE

Fields inherited from interface org.apache.commons.vfs2.FileObject

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GzipFileObject(AbstractFileName name, FileObject container, CompressedFileFileSystem fs) Deprecated. Use GzipFileObject(AbstractFileName, FileObject, GzipFileSystem) instead.
protected	GzipFileObject(AbstractFileName name, FileObject container, GzipFileSystem fs)

Method Summary

Modifier and Type	Method and Description
protected InputStream	doGetInputStream(int bufferSize) Creates an input stream to read the file content from.
protected OutputStream	doGetOutputStream(boolean bAppend) Creates an output stream to write the file content to.

Methods inherited from class org.apache.commons.vfs2.provider.compressed.CompressedFileFileObject

createFile, doGetContentSize, doGetLastModifiedTime, doGetType, doListChildren, getContainer, isWriteable

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

canRenameTo, childrenChanged, close, compareTo, copyFrom, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doCreateFolder, doDelete, doDetach, doGetAttributes, doGetCertificates, doGetInputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, 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 org.apache.commons.vfs2.FileObject

getPath, getURI

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GzipFileObject

@Deprecated
protected GzipFileObject(AbstractFileName name,
                                     FileObject container,
                                     CompressedFileFileSystem fs)

Deprecated. Use GzipFileObject(AbstractFileName, FileObject, GzipFileSystem) instead.

Deprecated since 2.1.

Parameters:

name - Abstract file name.

container - My container.

fs - My file system.

GzipFileObject

protected GzipFileObject(AbstractFileName name,
                         FileObject container,
                         GzipFileSystem fs)

Method Detail

doGetInputStream

protected InputStream doGetInputStream(int bufferSize)
                                throws Exception

Description copied from class: AbstractFileObject

Creates an input stream to read the file content from. Is only called if AbstractFileObject.doGetType() returns FileType.FILE.

It is guaranteed that there are no open output streams for this file when this method is called.

The returned stream does not have to be buffered.

Overrides:

doGetInputStream in class AbstractFileObject<GzipFileSystem>

Parameters:

bufferSize - Buffer size hint.

Returns:

An InputStream to read the file content.

Throws:

Exception - if an error occurs.

doGetOutputStream

protected OutputStream doGetOutputStream(boolean bAppend)
                                  throws Exception

Description copied from class: AbstractFileObject

Creates an output stream to write the file content to. Is only called if:

• AbstractFileObject.doIsWriteable() returns true.
• AbstractFileObject.doGetType() returns FileType.FILE, or AbstractFileObject.doGetType() returns FileType.IMAGINARY, and the file's parent exists and is a folder.

It is guaranteed that there are no open stream (input or output) for this file when this method is called.

The returned stream does not have to be buffered.

This implementation throws an exception.

Overrides:

doGetOutputStream in class AbstractFileObject<GzipFileSystem>

Parameters:

bAppend - true if the file should be appended to, false if it should be overwritten.

Returns:

An OutputStream to write to the file.

Throws:

Exception - if an error occurs.