TarDriver (TrueZIP Driver TAR 7.3.3 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsDriver
- - de.schlichtherle.truezip.fs.archive.FsArchiveDriver<E>
  - - de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver<TTarArchiveEntry>
    - - de.schlichtherle.truezip.fs.archive.tar.TarDriver

Direct Known Subclasses:: TarBZip2Driver, TarGZipDriver

@Immutable
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class TarDriver
extends FsCharsetArchiveDriver<TTarArchiveEntry>

An archive driver which builds Tape Archive files (TAR).

Author:: Christian Schlichtherle

Field Summary

Fields
Modifier and Type Field and Description

private IOPoolProvider provider

static Charset TAR_CHARSET
The default character set for entry names and comments, which is "US-ASCII".

Fields
Modifier and Type	Field and Description
`private IOPoolProvider`	`provider`
`static Charset`	`TAR_CHARSET` The default character set for entry names and comments, which is `"US-ASCII"`.

Constructor Summary

Constructors
Constructor and Description

TarDriver(IOPoolProvider provider)

Constructors
Constructor and Description
`TarDriver(IOPoolProvider provider)`

Method Summary

Methods
Modifier and Type	Method and Description
`InputSocket<?>`	`getInputSocket(FsController<?> controller, FsEntryName name, BitField<FsInputOption> options)` Clears `FsInputOption.CACHE` in `options` before forwarding the call to `controller`.
`OutputSocket<?>`	`getOutputSocket(FsController<?> controller, FsEntryName name, BitField<FsOutputOption> options, Entry template)` Sets `FsOutputOption.COMPRESS` in `options` before forwarding the call to `controller`.
`protected IOPool<?>`	`getPool()`
`boolean`	`getRedundantContentSupport()`
`TTarArchiveEntry`	`newEntry(String name)`
`TTarArchiveEntry`	`newEntry(String name, Entry.Type type, Entry template, BitField<FsOutputOption> mknod)`
`TTarArchiveEntry`	`newEntry(String name, TarArchiveEntry template)`
`TarInputShop`	`newInputShop(FsModel model, InputSocket<?> input)` The implementation in the class `TarDriver` acquires an input stream from the given socket and forwards the call to `newTarInputShop(de.schlichtherle.truezip.fs.FsModel, java.io.InputStream)`.
`OutputShop<TTarArchiveEntry>`	`newOutputShop(FsModel model, OutputSocket<?> output, InputShop<TTarArchiveEntry> source)` The implementation in the class `TarDriver` acquires an output stream from the given socket, forwards the call to `newTarOutputShop(de.schlichtherle.truezip.fs.FsModel, java.io.OutputStream, de.schlichtherle.truezip.fs.archive.tar.TarInputShop)` and wraps the result in a new `FsMultiplexedOutputShop`.
`protected TarInputShop`	`newTarInputShop(FsModel model, InputStream in)`
`protected TarOutputShop`	`newTarOutputShop(FsModel model, OutputStream out, TarInputShop source)`

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver
assertEncodable, getCharset, toString, toZipOrTarEntryName

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsArchiveDriver
getClosedIcon, getOpenIcon, getRedundantMetaDataSupport, isFederated, newController, newEntry, newInputStream, newOutputStream, newReadOnlyFile

Methods inherited from class de.schlichtherle.truezip.fs.FsDriver
getPriority

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- provider
```
private final IOPoolProvider provider
```
- TAR_CHARSET
```
public static final Charset TAR_CHARSET
```
  The default character set for entry names and comments, which is "US-ASCII".

Constructor Detail

TarDriver

public TarDriver(IOPoolProvider provider)

Method Detail

getInputSocket

public InputSocket<?> getInputSocket(FsController<?> controller,
                            FsEntryName name,
                            BitField<FsInputOption> options)

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

Overrides:: getInputSocket in class FsArchiveDriver<TTarArchiveEntry>

getOutputSocket

public OutputSocket<?> getOutputSocket(FsController<?> controller,
                              FsEntryName name,
                              BitField<FsOutputOption> options,
                              @CheckForNull
                              Entry template)

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

Overrides:: getOutputSocket in class FsArchiveDriver<TTarArchiveEntry>

getPool
```
protected final IOPool<?> getPool()
```
Specified by:

getPool in class FsArchiveDriver<TTarArchiveEntry>

getRedundantContentSupport
```
public boolean getRedundantContentSupport()
```
Overrides:

getRedundantContentSupport in class FsArchiveDriver<TTarArchiveEntry>

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 TTarArchiveEntry newEntry(String name)

newEntry

public TTarArchiveEntry newEntry(String name,
                        Entry.Type type,
                        Entry template,
                        BitField<FsOutputOption> mknod)
                          throws CharConversionException

Specified by:: newEntry in class FsArchiveDriver<TTarArchiveEntry>
Throws:: CharConversionException

newEntry

public TTarArchiveEntry newEntry(String name,
                        TarArchiveEntry template)

newInputShop
```
public TarInputShop newInputShop(FsModel model,
                        InputSocket<?> input)
                          throws IOException
```
The implementation in the class TarDriver acquires an input stream from the given socket and forwards the call to newTarInputShop(de.schlichtherle.truezip.fs.FsModel, java.io.InputStream).

Specified by:

newInputShop in class FsArchiveDriver<TTarArchiveEntry>

Throws:

IOException

newOutputShop
```
public OutputShop<TTarArchiveEntry> newOutputShop(FsModel model,
                                         OutputSocket<?> output,
                                         InputShop<TTarArchiveEntry> source)
                                           throws IOException
```
The implementation in the class TarDriver acquires an output stream from the given socket, forwards the call to newTarOutputShop(de.schlichtherle.truezip.fs.FsModel, java.io.OutputStream, de.schlichtherle.truezip.fs.archive.tar.TarInputShop) and wraps the result in a new FsMultiplexedOutputShop.

Specified by:

newOutputShop in class FsArchiveDriver<TTarArchiveEntry>

Throws:

IOException

newTarInputShop

protected TarInputShop newTarInputShop(FsModel model,
                           InputStream in)
                                throws IOException

Throws:: IOException

newTarOutputShop

protected TarOutputShop newTarOutputShop(FsModel model,
                             OutputStream out,
                             TarInputShop source)
                                  throws IOException

Throws:: IOException

Class TarDriver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsArchiveDriver

Methods inherited from class de.schlichtherle.truezip.fs.FsDriver

Methods inherited from class java.lang.Object

Field Detail

provider

TAR_CHARSET

Constructor Detail

TarDriver

Method Detail

getInputSocket

getOutputSocket

getPool

getRedundantContentSupport

newEntry

newEntry

newEntry

newInputShop

newOutputShop

newTarInputShop

newTarOutputShop