org.at4j.comp.lzma

Class LzmaReadableFile

java.lang.Object

org.at4j.comp.lzma.LzmaReadableFile

All Implemented Interfaces:

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

public class LzmaReadableFile
extends Object
implements org.entityfs.ReadableFile

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

The LZMA stream is opened on a buffered input stream whose buffer size can be configured.

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

Since:

1.0

Author:

Karl Gustafsson

See Also:

LzmaWritableFile, GZipReadableFile, BZip2ReadableFile

Constructor Summary

Constructors

Constructor and Description
LzmaReadableFile(org.entityfs.ReadableFile adapted) Create a new adapter.
LzmaReadableFile(org.entityfs.ReadableFile adapted, int bufSize) 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

LzmaReadableFile

public LzmaReadableFile(org.entityfs.ReadableFile adapted)

Create a new adapter. LZMA streams will be opened on buffered streams with the default BufferedInputStream buffer size.

Parameters:

adapted - The adapted file.

See Also:

LzmaReadableFile(ReadableFile, int)

LzmaReadableFile

public LzmaReadableFile(org.entityfs.ReadableFile adapted,
                int bufSize)
                 throws IllegalArgumentException

Create a new adapter. LZMA streams will be opened on buffered streams having the supplied buffer size.

Parameters:

adapted - The adapted file.

bufSize - The buffer size for buffered input streams.

Throws:

IllegalArgumentException - If the buffer size is < 1

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