net.java.truevfs.comp.tardriver

Class TarDriver

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TarBZip2Driver, TarGZipDriver, TarXZDriver

@Immutable
public class TarDriver
extends FsArchiveDriver<TarDriverEntry>

An archive driver for Tape Archive files (TAR). By default, TAR files use the US-ASCII character set for the encoding of entry names. This configuration pretty much constraints the applicability of this file format to North American countries.

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	TAR_CHARSET The character set for entry names and comments, which is the default character set.

Constructor Summary

Constructors

Constructor and Description
TarDriver()

Method Summary

Modifier and Type	Method and Description
boolean	getAddPaxHeaderForNonAsciiNames() Returns true if writing PAX headers for non US-ASCII entry names should be supported or not.
int	getBigNumberMode() Returns the method to use for writing entries of more than TarConstants.MAXSIZE (8 GiB) size.
Charset	getCharset() Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file.
int	getLongFileMode() Returns the method to use for encoding entry names with TarConstants.NAMELEN or more characters.
net.java.truecommons.cio.IoBufferPool	getPool() Returns the pool for allocating temporary I/O buffers.
boolean	getRedundantContentSupport() Returns true if and only if the archive files produced by this archive driver may contain redundant archive entry contents.
TarDriverEntry	newEntry(net.java.truecommons.shed.BitField<FsAccessOption> options, String name, net.java.truecommons.cio.Entry.Type type, net.java.truecommons.cio.Entry template) Returns a new entry for the given name.
TarDriverEntry	newEntry(String name)
TarDriverEntry	newEntry(String name, TarArchiveEntry template)
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.COMPRESS in options before forwarding the call to controller.
protected FsInputSocketSource	source(net.java.truecommons.shed.BitField<FsAccessOption> options, FsController controller, FsNodeName name) Clears FsAccessOption.CACHE in options before forwarding the call to controller.

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

Field Detail

TAR_CHARSET

public static final Charset TAR_CHARSET

The character set for entry names and comments, which is the default character set.

Constructor Detail

TarDriver

public TarDriver()

Method Detail

getAddPaxHeaderForNonAsciiNames

public boolean getAddPaxHeaderForNonAsciiNames()

Returns true if writing PAX headers for non US-ASCII entry names should be supported or not. As of TrueVFS 0.10.7, the implementation in TarDriver returns true. In older versions, the behaviour was as if this method returned false.

Since:

TrueVFS 0.10.7

getBigNumberMode

public int getBigNumberMode()

Returns the method to use for writing entries of more than TarConstants.MAXSIZE (8 GiB) size. As of TrueVFS 0.10.7, the implementation in TarDriver returns TarArchiveOutputStream.BIGNUMBER_POSIX. In older versions, the behaviour was as if this method returned TarArchiveOutputStream.BIGNUMBER_ERROR.

Since:

TrueVFS 0.10.7

getCharset

public Charset getCharset()

Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file. Depending on the archive file format, this may get used for decoding binary data when reading an archive file, too.

This is an immutable property - multiple calls must return the same object.

Specified by:

getCharset in class FsArchiveDriver<TarDriverEntry>

Returns:

TAR_CHARSET.

getLongFileMode

public int getLongFileMode()

Returns the method to use for encoding entry names with TarConstants.NAMELEN or more characters. As of TrueVFS 0.10.7, the implementation in TarDriver returns TarArchiveOutputStream.LONGFILE_POSIX. In older versions, the implementation returned TarArchiveOutputStream.LONGFILE_GNU.

getPool

public net.java.truecommons.cio.IoBufferPool getPool()

Returns the pool for allocating temporary I/O buffers.

This is an immutable property - multiple calls must return the same object.

The implementation in the class TarDriver calls IoBufferPoolLocator.SINGLETON.get().

Specified by:

getPool in class FsArchiveDriver<TarDriverEntry>

Returns:

The pool to use for allocating temporary I/O buffers.

getRedundantContentSupport

public boolean getRedundantContentSupport()

Returns true if and only if the archive files produced by this archive driver may contain redundant archive entry contents. If the return value is true, then an archive file may contain redundant archive entry contents, but only the last contents written should get used when reading the archive file.

This is an immutable property - multiple calls must return the same value.

The default value of this property is false as defined by the implementation in the class FsArchiveDriver.

Overrides:

getRedundantContentSupport in class FsArchiveDriver<TarDriverEntry>

Returns:

The implementation in the class TarDriver returns true because when reading a TAR file sequentially, each TAR entry should "override" any previously read TAR entry with an equal name.

newEntry

public TarDriverEntry newEntry(net.java.truecommons.shed.BitField<FsAccessOption> options,
                               String name,
                               net.java.truecommons.cio.Entry.Type type,
                               @CheckForNull
                               net.java.truecommons.cio.Entry template)

Description copied from class: FsArchiveDriver

Returns a new entry for the given name. The implementation may change this name in order to form a valid entry name for their particular requirements.

Specified by:

newEntry in class FsArchiveDriver<TarDriverEntry>

Parameters:

options - when called from FsController.make(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption>, net.java.truevfs.kernel.spec.FsNodeName, net.java.truecommons.cio.Entry.Type, net.java.truecommons.cio.Entry), this is its options parameter, otherwise it's typically an empty set.

name - the entry name.

type - the entry type.

template - if not null, then the new entry shall inherit as much properties from this entry as possible - with the exception of its name and type.

Returns:

A new entry for the given name.

See Also:

FsArchiveDriver.newEntry(String, Entry.Type, Entry)

newEntry

public TarDriverEntry newEntry(String name)

newEntry

public TarDriverEntry newEntry(String name,
                               TarArchiveEntry template)

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.

Specified by:

newInput in class FsArchiveDriver<TarDriverEntry>

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,
                                                                           @CheckForNull @WillNotClose
                                                                           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.

Specified by:

newOutput in class FsArchiveDriver<TarDriverEntry>

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.COMPRESS in options before forwarding the call to controller.

Overrides:

sink in class FsArchiveDriver<TarDriverEntry>

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)

source

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

Clears FsAccessOption.CACHE in options before forwarding the call to controller.

Overrides:

source in class FsArchiveDriver<TarDriverEntry>

Parameters:

options - the options for accessing the file system node.

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

name - the node name.

Returns:

A source for reading an artifact of this driver.

See Also:

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