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:

net.java.truevfs.kernel.spec.FsController.Factory<net.java.truevfs.kernel.spec.FsManager>, net.java.truevfs.kernel.spec.FsModel.Factory<net.java.truevfs.kernel.spec.FsManager>

@Immutable
public class TarDriver
extends net.java.truevfs.kernel.spec.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!

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.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.
java.nio.charset.Charset	getCharset()
int	getLongFileMode() Returns the method to use for encoding entry names with TarConstants.NAMELEN or more characters.
net.java.truecommons.cio.IoBufferPool	getPool()
boolean	getRedundantContentSupport()
TarDriverEntry	newEntry(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption> options, java.lang.String name, net.java.truecommons.cio.Entry.Type type, net.java.truecommons.cio.Entry template)
TarDriverEntry	newEntry(java.lang.String name)
TarDriverEntry	newEntry(java.lang.String name, org.apache.commons.compress.archivers.tar.TarArchiveEntry template)
protected net.java.truecommons.cio.InputService<TarDriverEntry>	newInput(net.java.truevfs.kernel.spec.FsModel model, net.java.truevfs.kernel.spec.FsInputSocketSource source)
protected net.java.truecommons.cio.OutputService<TarDriverEntry>	newOutput(net.java.truevfs.kernel.spec.FsModel model, net.java.truevfs.kernel.spec.FsOutputSocketSink sink, net.java.truecommons.cio.InputService<TarDriverEntry> input)
protected net.java.truevfs.kernel.spec.FsOutputSocketSink	sink(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption> options, net.java.truevfs.kernel.spec.FsController controller, net.java.truevfs.kernel.spec.FsNodeName name) Sets FsAccessOption.COMPRESS in options before forwarding the call to controller.
protected net.java.truevfs.kernel.spec.FsInputSocketSource	source(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption> options, net.java.truevfs.kernel.spec.FsController controller, net.java.truevfs.kernel.spec.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 java.nio.charset.Charset TAR_CHARSET

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

Constructor Detail

TarDriver

public TarDriver()

Method Detail

getCharset

public java.nio.charset.Charset getCharset()

Specified by:

getCharset in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

Returns:

TAR_CHARSET.

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

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.

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

getPool

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

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

Specified by:

getPool in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

getRedundantContentSupport

public boolean getRedundantContentSupport()

Overrides:

getRedundantContentSupport in class net.java.truevfs.kernel.spec.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.

newInput

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

Specified by:

newInput in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

Throws:

java.io.IOException

newOutput

protected net.java.truecommons.cio.OutputService<TarDriverEntry> newOutput(net.java.truevfs.kernel.spec.FsModel model,
                                                                           net.java.truevfs.kernel.spec.FsOutputSocketSink sink,
                                                                           @CheckForNull @WillNotClose
                                                                           net.java.truecommons.cio.InputService<TarDriverEntry> input)
                                                                    throws java.io.IOException

Specified by:

newOutput in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

Throws:

java.io.IOException

source

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

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

Overrides:

source in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

sink

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

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

Overrides:

sink in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

newEntry

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

Specified by:

newEntry in class net.java.truevfs.kernel.spec.FsArchiveDriver<TarDriverEntry>

newEntry

public TarDriverEntry newEntry(java.lang.String name)

newEntry

public TarDriverEntry newEntry(java.lang.String name,
                               org.apache.commons.compress.archivers.tar.TarArchiveEntry template)