org.at4j.comp.lzma

Class LzmaWritableFile

java.lang.Object

org.at4j.comp.lzma.LzmaWritableFile

All Implemented Interfaces:

org.entityfs.lock.Lockable, org.entityfs.lock.WriteLockable, org.entityfs.WritableFile

public class LzmaWritableFile
extends Object
implements org.entityfs.WritableFile

This is a WritableFile that transparently compresses the data written to a file using LZMA compression. The LZMA output stream is opened on a buffered output stream on the file. The buffer size can be configured.

This file cannot be appended to. The openForAppend methods throw an UnsupportedOperationException.

Since:

1.0

Author:

Karl Gustafsson

See Also:

LzmaReadableFile, GZipWritableFile, BZip2WritableFile

Constructor Summary

Constructors

Constructor and Description
LzmaWritableFile(org.entityfs.WritableFile adapted) Create a new adapter using the default LZMA compression settings.
LzmaWritableFile(org.entityfs.WritableFile adapted, LzmaOutputStreamSettings settings) Create a new adapter using the supplied LZMA settings

Method Summary

Methods

Modifier and Type	Method and Description
org.entityfs.lock.EntityLock	getWriteLock()
boolean	isWriteLockedByCurrentThread()
org.entityfs.lock.EntityLock	lockForWriting()
WritableByteChannel	openChannelForAppend() This method always throws an UnsupportedOperationException.
WritableByteChannel	openChannelForWrite()
OutputStream	openForAppend() This method always throws an UnsupportedOperationException.
OutputStream	openForWrite()

Methods inherited from class java.lang.Object

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

Constructor Detail

LzmaWritableFile

public LzmaWritableFile(org.entityfs.WritableFile adapted)

Create a new adapter using the default LZMA compression settings. LZMA output streams will be opened on buffered output streams using BufferedOutputStream's default buffer size.

Parameters:

adapted - The writable file to adapt.

LzmaWritableFile

public LzmaWritableFile(org.entityfs.WritableFile adapted,
                LzmaOutputStreamSettings settings)

Create a new adapter using the supplied LZMA settings

Parameters:

adapted - The writable file to adapt.

settings - Compression configuration. Set this to null to use the default configuration.

Method Detail

openChannelForAppend

public WritableByteChannel openChannelForAppend()
                                         throws UnsupportedOperationException

This method always throws an UnsupportedOperationException.

Specified by:

openChannelForAppend in interface org.entityfs.WritableFile

Throws:

UnsupportedOperationException - Always.

openChannelForWrite

public WritableByteChannel openChannelForWrite()
                                        throws org.entityfs.lock.WriteLockRequiredException,
                                               org.entityfs.security.AccessDeniedException,
                                               org.entityfs.exception.ReadOnlyException

Specified by:

openChannelForWrite in interface org.entityfs.WritableFile

Throws:

org.entityfs.lock.WriteLockRequiredException

org.entityfs.security.AccessDeniedException

org.entityfs.exception.ReadOnlyException

openForAppend

public OutputStream openForAppend()
                           throws UnsupportedOperationException

This method always throws an UnsupportedOperationException.

Specified by:

openForAppend in interface org.entityfs.WritableFile

Throws:

UnsupportedOperationException - Always.

openForWrite

public OutputStream openForWrite()
                          throws org.entityfs.lock.WriteLockRequiredException,
                                 org.entityfs.security.AccessDeniedException,
                                 org.entityfs.exception.ReadOnlyException

Specified by:

openForWrite in interface org.entityfs.WritableFile

Throws:

org.entityfs.lock.WriteLockRequiredException

org.entityfs.security.AccessDeniedException

org.entityfs.exception.ReadOnlyException

getWriteLock

public org.entityfs.lock.EntityLock getWriteLock()

Specified by:

getWriteLock in interface org.entityfs.lock.WriteLockable

isWriteLockedByCurrentThread

public boolean isWriteLockedByCurrentThread()

Specified by:

isWriteLockedByCurrentThread in interface org.entityfs.lock.WriteLockable

lockForWriting

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

Specified by:

lockForWriting in interface org.entityfs.lock.WriteLockable

Throws:

org.entityfs.exception.LockTimeoutException