net.java.truevfs.driver.tar.gzip

Class TarGZipDriver

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsDriver

net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

net.java.truevfs.comp.tardriver.TarDriver

net.java.truevfs.driver.tar.gzip.TarGZipDriver

All Implemented Interfaces:

FsController.Factory<FsManager>, FsModel.Factory<FsManager>

@Immutable
public class TarGZipDriver
extends TarDriver

An archive driver for GZIP compressed TAR files (TAR.GZIP).

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

Field Summary

Fields inherited from class net.java.truevfs.comp.tardriver.TarDriver

TAR_CHARSET

Constructor Summary

Constructors

Constructor and Description
TarGZipDriver()

Method Summary

Modifier and Type	Method and Description
int	getBufferSize() Returns the size of the I/O buffer.
int	getLevel() Returns the compression level to use when writing a GZIP sink stream.
protected net.java.truecommons.cio.InputService<TarDriverEntry>	newInput(FsModel model, FsInputSocketSource source) Creates a new input service for reading archive entries for the given model from the target archive file referenced by source.
protected net.java.truecommons.cio.OutputService<TarDriverEntry>	newOutput(FsModel model, FsOutputSocketSink sink, net.java.truecommons.cio.InputService<TarDriverEntry> input) Creates a new input service for writing archive entries for the given model to the target archive file referenced by sink.
protected FsOutputSocketSink	sink(net.java.truecommons.shed.BitField<FsAccessOption> options, FsController controller, FsNodeName name) Sets FsAccessOption.STORE in options before forwarding the call to controller.

Methods inherited from class net.java.truevfs.comp.tardriver.TarDriver

getAddPaxHeaderForNonAsciiNames, getBigNumberMode, getCharset, getLongFileMode, getPool, getRedundantContentSupport, newEntry, newEntry, newEntry, source

Methods inherited from class net.java.truevfs.kernel.spec.FsArchiveDriver

checkEncodable, decorate, getRedundantMetaDataSupport, isArchiveDriver, newController, newEntry, newInput, newOutput, normalize, toString

Methods inherited from class net.java.truevfs.kernel.spec.FsDriver

decorate, newModel

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TarGZipDriver

public TarGZipDriver()

Method Detail

getBufferSize

public int getBufferSize()

Returns the size of the I/O buffer.

The implementation in the class TarGZipDriver returns Streams.BUFFER_SIZE.

Returns:

The size of the I/O buffer.

getLevel

public int getLevel()

Returns the compression level to use when writing a GZIP sink stream.

The implementation in the class TarGZipDriver returns Deflater.BEST_COMPRESSION.

Returns:

The compression level to use when writing a GZIP sink stream.

newInput

protected net.java.truecommons.cio.InputService<TarDriverEntry> newInput(FsModel model,
                                                                         FsInputSocketSource source)
                                                                  throws IOException

Description copied from class: FsArchiveDriver

Creates a new input service for reading archive entries for the given model from the target archive file referenced by source.

Overrides:

newInput in class TarDriver

Parameters:

model - the file system model.

source - the source for reading the target archive file.

Returns:

A new input service. Note that this service does not need to be thread-safe!

Throws:

IOException - on any I/O error.

See Also:

FsArchiveDriver.newInput(FsModel, BitField, FsController, FsNodeName)

newOutput

protected net.java.truecommons.cio.OutputService<TarDriverEntry> newOutput(FsModel model,
                                                                           FsOutputSocketSink sink,
                                                                           net.java.truecommons.cio.InputService<TarDriverEntry> input)
                                                                    throws IOException

Description copied from class: FsArchiveDriver

Creates a new input service for writing archive entries for the given model to the target archive file referenced by sink.

Overrides:

newOutput in class TarDriver

Parameters:

model - the file system model.

sink - the sink for writing the target archive file.

input - the nullable InputService for the target archive file. If not null, then the target archive file is going to get updated. This parameter is guaranteed to be the product of this driver's factory method FsArchiveDriver.newInput(FsModel, BitField, FsController, FsNodeName).

Returns:

A new output service for writing the target archive file. Note that this service does not need to be thread-safe!

Throws:

IOException - on any I/O error.

See Also:

FsArchiveDriver.newOutput(FsModel, BitField, FsController, FsNodeName, InputService)

sink

protected FsOutputSocketSink sink(net.java.truecommons.shed.BitField<FsAccessOption> options,
                                  FsController controller,
                                  FsNodeName name)

Sets FsAccessOption.STORE in options before forwarding the call to controller.

Overrides:

sink in class TarDriver

Parameters:

options - the options for accessing the file system node.

controller - the controller to use for writing an artifact of this driver.

name - the node name.

Returns:

A sink for writing an artifact of this driver.

See Also:

FsArchiveDriver.newOutput(FsModel, BitField, FsController, FsNodeName, InputService)