com.ice.tar

Class TarOutputStream

Known Direct Subclasses:
TarGzOutputStream

public class TarOutputStream
extends FilterOutputStream

The TarOutputStream writes a UNIX tar archive as an OutputStream. Methods are provided to put entries, and then write their contents by writing to this stream using write(). Kerry Menzel <kmenzel@cfl.rr.com> Contributed the code to support file sizes greater than 2GB (longs versus ints).
Version:
$Revision: 1.8 $
Author:
Timothy Gerard Endres,
See Also:
TarBuffer, TarHeader, TarEntry

Field Summary

protected byte[]
assemBuf
protected int
assemLen
protected TarBuffer
buffer
protected long
currBytes
protected long
currSize
protected boolean
debug
protected byte[]
oneBuf
protected byte[]
recordBuf

Constructor Summary

TarOutputStream(OutputStream os)
TarOutputStream(OutputStream os, int blockSize)
TarOutputStream(OutputStream os, int blockSize, int recordSize)

Method Summary

void
close()
Ends the TAR archive and closes the underlying OutputStream.
void
closeEntry()
Close an entry.
void
finish()
Ends the TAR archive without closing the underlying OutputStream.
int
getRecordSize()
Get the record size being used by this stream's TarBuffer.
void
putNextEntry(TarEntry entry)
Put an entry on the output stream.
void
setBufferDebug(boolean debug)
Sets the debugging flag in this stream's TarBuffer.
void
setDebug(boolean debugF)
Sets the debugging flag.
void
write(byte[] wBuf)
Writes bytes to the current tar archive entry.
void
write(byte[] wBuf, int wOffset, int numToWrite)
Writes bytes to the current tar archive entry.
void
write(int b)
Writes a byte to the current tar archive entry.

Field Details

assemBuf

protected byte[] assemBuf

assemLen

protected int assemLen

buffer

protected TarBuffer buffer

currBytes

protected long currBytes

currSize

protected long currSize

debug

protected boolean debug

oneBuf

protected byte[] oneBuf

recordBuf

protected byte[] recordBuf

Constructor Details

TarOutputStream

public TarOutputStream(OutputStream os)

TarOutputStream

public TarOutputStream(OutputStream os,
                       int blockSize)

TarOutputStream

public TarOutputStream(OutputStream os,
                       int blockSize,
                       int recordSize)

Method Details

close

public void close()
            throws IOException
Ends the TAR archive and closes the underlying OutputStream. This means that finish() is called followed by calling the TarBuffer's close().

closeEntry

public void closeEntry()
            throws IOException
Close an entry. This method MUST be called for all file entries that contain data. The reason is that we must buffer data written to the stream in order to satisfy the buffer's record based writes. Thus, there may be data fragments still being assembled that must be written to the output stream before this entry is closed and the next entry written.

finish

public void finish()
            throws IOException
Ends the TAR archive without closing the underlying OutputStream. The result is that the EOF record of nulls is written.

getRecordSize

public int getRecordSize()
Get the record size being used by this stream's TarBuffer.
Returns:
The TarBuffer record size.

putNextEntry

public void putNextEntry(TarEntry entry)
            throws IOException
Put an entry on the output stream. This writes the entry's header record and positions the output stream for writing the contents of the entry. Once this method is called, the stream is ready for calls to write() to write the entry's contents. Once the contents are written, closeEntry() MUST be called to ensure that all buffered data is completely written to the output stream.
Parameters:
entry - The TarEntry to be written to the archive.

setBufferDebug

public void setBufferDebug(boolean debug)
Sets the debugging flag in this stream's TarBuffer.
Parameters:

setDebug

public void setDebug(boolean debugF)
Sets the debugging flag.
Parameters:
debugF - True to turn on debugging.

write

public void write(byte[] wBuf)
            throws IOException
Writes bytes to the current tar archive entry. This method simply calls read( byte[], int, int ).
Parameters:
wBuf - The buffer to write to the archive.

write

public void write(byte[] wBuf,
                  int wOffset,
                  int numToWrite)
            throws IOException
Writes bytes to the current tar archive entry. This method is aware of the current entry and will throw an exception if you attempt to write bytes past the length specified for the current entry. The method is also (painfully) aware of the record buffering required by TarBuffer, and manages buffers that are not a multiple of recordsize in length, including assembling records from small buffers. This method simply calls read( byte[], int, int ).
Parameters:
wBuf - The buffer to write to the archive.
wOffset - The offset in the buffer from which to get bytes.
numToWrite - The number of bytes to write.

write

public void write(int b)
            throws IOException
Writes a byte to the current tar archive entry. This method simply calls read( byte[], int, int ).
Parameters:
b - The byte written.

This software has been placed into the public domain.