org.at4j.comp.bzip2

Class BZip2ReadableFile

java.lang.Object

org.at4j.comp.bzip2.BZip2ReadableFile

All Implemented Interfaces:

org.entityfs.lock.Lockable, org.entityfs.lock.ReadLockable, org.entityfs.ReadableFile

public class BZip2ReadableFile
extends Object
implements org.entityfs.ReadableFile

This is a ReadableFile that transparently decompresses the contents of a wrapped file using bzip2.

bzip2 input streams are opened on buffered input streams on the underlying file. The buffer size can be configured.

A ReadableFile can be made into a NamedReadableFile using the NamedReadableFileAdapter.

Since:

1.0

Author:

Karl Gustafsson

See Also:

BZip2WritableFile, LzmaReadableFile, GZipReadableFile, BZip2InputStream

Constructor Summary

Constructors

Constructor and Description
BZip2ReadableFile(org.entityfs.ReadableFile adapted) Create a new adapter.
BZip2ReadableFile(org.entityfs.ReadableFile adapted, boolean assumeMagicBytes) Deprecated. The assumeMagicBytes property is always true from At4J 1.1.
BZip2ReadableFile(org.entityfs.ReadableFile adapted, boolean assumeMagicBytes, int bufferSize) Deprecated. The assumeMagicBytes property is always true from At4J 1.1.
BZip2ReadableFile(org.entityfs.ReadableFile adapted, BZip2ReadableFileSettings settings) Create a new adapter.

Method Summary

Methods

Modifier and Type	Method and Description
long	getDataSize()
org.entityfs.lock.EntityLock	getReadLock()
long	getSize()
boolean	isReadLockedByCurrentThread()
org.entityfs.lock.EntityLock	lockForReading()
ReadableByteChannel	openChannelForRead()
InputStream	openForRead()

Methods inherited from class java.lang.Object

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

Constructor Detail

BZip2ReadableFile

public BZip2ReadableFile(org.entityfs.ReadableFile adapted)

Create a new adapter. The adapter will assume that the bzip2 compressed data does not start with the two magic bytes "BZ".

Parameters:

adapted - The adapted file.

See Also:

BZip2ReadableFile(ReadableFile, BZip2ReadableFileSettings)

BZip2ReadableFile

@Deprecated
public BZip2ReadableFile(org.entityfs.ReadableFile adapted,
                            boolean assumeMagicBytes)

Deprecated. The assumeMagicBytes property is always true from At4J 1.1.

Create a new adapter. The adapter will use the default buffer size of 8192 bytes.

Parameters:

adapted - The adapted file.

assumeMagicBytes - Does the compressed data in the file start with the two magic bytes "BZ"? Starting with At4J 1.1, this property must be true.

BZip2ReadableFile

@Deprecated
public BZip2ReadableFile(org.entityfs.ReadableFile adapted,
                            boolean assumeMagicBytes,
                            int bufferSize)

Deprecated. The assumeMagicBytes property is always true from At4J 1.1.

Create a new adapter.

Parameters:

adapted - The adapted file.

assumeMagicBytes - Does the compressed data in the file start with the two magic bytes "BZ"? Starting with At4J 1.1, this property must be true.

bufferSize - The size of the buffer for the buffered input stream that the bzip2 input stream is opened on. Set this to -1 to use the default buffer size (8192 bytes).

BZip2ReadableFile

public BZip2ReadableFile(org.entityfs.ReadableFile adapted,
                 BZip2ReadableFileSettings settings)

Create a new adapter.

Parameters:

adapted - The adapted file.

settings - The settings for this readable file. A clone of the settings object is stored in the created object.

Since:

1.1

See Also:

BZip2ReadableFile(ReadableFile)

Method Detail

openChannelForRead

public ReadableByteChannel openChannelForRead()
                                       throws org.entityfs.lock.ReadLockRequiredException,
                                              org.entityfs.security.AccessDeniedException

Specified by:

openChannelForRead in interface org.entityfs.ReadableFile

Throws:

org.entityfs.lock.ReadLockRequiredException

org.entityfs.security.AccessDeniedException

openForRead

public InputStream openForRead()
                        throws org.entityfs.lock.ReadLockRequiredException,
                               org.entityfs.security.AccessDeniedException

Specified by:

openForRead in interface org.entityfs.ReadableFile

Throws:

org.entityfs.lock.ReadLockRequiredException

org.entityfs.security.AccessDeniedException

getReadLock

public org.entityfs.lock.EntityLock getReadLock()

Specified by:

getReadLock in interface org.entityfs.lock.ReadLockable

isReadLockedByCurrentThread

public boolean isReadLockedByCurrentThread()
                                    throws IllegalStateException

Specified by:

isReadLockedByCurrentThread in interface org.entityfs.lock.ReadLockable

Throws:

IllegalStateException

lockForReading

public org.entityfs.lock.EntityLock lockForReading()
                                            throws org.entityfs.exception.LockTimeoutException

Specified by:

lockForReading in interface org.entityfs.lock.ReadLockable

Throws:

org.entityfs.exception.LockTimeoutException

getDataSize

public long getDataSize()
                 throws org.entityfs.lock.ReadLockRequiredException,
                        org.entityfs.security.AccessDeniedException

Specified by:

getDataSize in interface org.entityfs.ReadableFile

Throws:

org.entityfs.lock.ReadLockRequiredException

org.entityfs.security.AccessDeniedException

getSize

public long getSize()
             throws org.entityfs.lock.ReadLockRequiredException,
                    org.entityfs.security.AccessDeniedException

Specified by:

getSize in interface org.entityfs.ReadableFile

Throws:

org.entityfs.lock.ReadLockRequiredException

org.entityfs.security.AccessDeniedException