net.java.truevfs.comp.tardriver

Class TarOutputService

java.lang.Object

net.java.truevfs.comp.tardriver.TarOutputService

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<TarDriverEntry>, net.java.truecommons.cio.Container<TarDriverEntry>, net.java.truecommons.cio.OutputService<TarDriverEntry>, net.java.truecommons.shed.Stream<TarDriverEntry>

@NotThreadSafe
public final class TarOutputService
extends Object
implements net.java.truecommons.cio.OutputService<TarDriverEntry>

An output service for writing TAR files. This output service can only write one entry concurrently.

Because the TAR file format needs to know each entry's length in advance, entries from an unknown source are actually written to temp files and copied to the underlying TarArchiveOutputStream upon a call to their OutputStream.close() method. Note that this implies that the close() method may fail with an IOException.

If the size of an entry is known in advance it's directly written to the underlying TarArchiveOutputStream instead.

Author:

Christian Schlichtherle

See Also:

TarInputService

Constructor Summary

Constructors

Constructor and Description
TarOutputService(FsModel model, net.java.truecommons.io.Sink sink, TarDriver driver)

Method Summary

Modifier and Type	Method and Description
void	close()
TarDriverEntry	entry(String name)
Iterator<TarDriverEntry>	iterator()
net.java.truecommons.cio.OutputSocket<TarDriverEntry>	output(TarDriverEntry local)
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TarOutputService

@CreatesObligation
public TarOutputService(FsModel model,
                                           net.java.truecommons.io.Sink sink,
                                           TarDriver driver)
                                    throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface net.java.truecommons.shed.Stream<TarDriverEntry>

Throws:

IOException

entry

@CheckForNull
public TarDriverEntry entry(String name)

Specified by:

entry in interface net.java.truecommons.cio.Container<TarDriverEntry>

iterator

public Iterator<TarDriverEntry> iterator()

Specified by:

iterator in interface Iterable<TarDriverEntry>

Specified by:

iterator in interface net.java.truecommons.cio.Container<TarDriverEntry>

output

public net.java.truecommons.cio.OutputSocket<TarDriverEntry> output(TarDriverEntry local)

Specified by:

output in interface net.java.truecommons.cio.OutputService<TarDriverEntry>

size

public int size()

Specified by:

size in interface net.java.truecommons.cio.Container<TarDriverEntry>