Package org.apache.commons.vfs2.provider.bzip2

Class Bzip2FileObject

java.lang.Object

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

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

org.apache.commons.vfs2.provider.bzip2.Bzip2FileObject

All Implemented Interfaces:

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

public class Bzip2FileObject
extends CompressedFileFileObject<Bzip2FileSystem>

the bzip2 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	Description
protected	Bzip2FileObject(AbstractFileName fileName, FileObject container, Bzip2FileSystem fileSystem)	Constructs a new instance.
protected	Bzip2FileObject(AbstractFileName name, FileObject container, CompressedFileFileSystem fs)	Deprecated. Use Bzip2FileObject(AbstractFileName, FileObject, Bzip2FileSystem) instead.

Method Summary

Modifier and Type	Method	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.
static InputStream	wrapInputStream(String name, InputStream inputStream)	Wraps an input stream in a compressor input stream.

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 Details

Bzip2FileObject

protected Bzip2FileObject(AbstractFileName fileName,
 FileObject container,
 Bzip2FileSystem fileSystem)

Constructs a new instance.

Parameters:

fileName - the file name.

container - the container.

fileSystem - the file system.

Bzip2FileObject

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

Deprecated.

Use Bzip2FileObject(AbstractFileName, FileObject, Bzip2FileSystem) instead.

Deprecated since 2.1.

Parameters:

name - Abstract file name.

container - My container.

fs - My file system.

Method Details

wrapInputStream

public static InputStream wrapInputStream(String name,
 InputStream inputStream)
                                   throws IOException

Wraps an input stream in a compressor input stream.

Parameters:

name - Unused.

inputStream - The input stream to wrap.

Returns:

a new compressor input stream.

Throws:

IOException - if the stream content is malformed or an I/O error occurs.

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<Bzip2FileSystem>

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<Bzip2FileSystem>

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.