org.codehaus.plexus.archiver.tar

Class TarOutputStream

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().

Version: $Revision: 2436 $ $Date: 2005-09-01 13:20:41 -0400 (Thu, 01 Sep 2005) $ from org.apache.ant.tools.tar.TarOutputStream v1.16

Field Summary
protected byte[]assemBuf
protected intassemLen
protected TarBufferbuffer
protected intcurrBytes
protected intcurrSize
protected booleandebug
protected intlongFileMode
static intLONGFILE_ERROR
Fail if a long file name is required in the archive.
static intLONGFILE_GNU
GNU tar extensions are used to store long file names in the archive.
static intLONGFILE_TRUNCATE
Long paths will be truncated in the archive.
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
voidclose()
Ends the TAR archive and closes the underlying OutputStream.
voidcloseEntry()
Close an entry.
voidfinish()
Ends the TAR archive without closing the underlying OutputStream.
intgetRecordSize()
Get the record size being used by this stream's TarBuffer.
voidputNextEntry(TarEntry entry)
Put an entry on the output stream.
voidsetBufferDebug(boolean debug)
Sets the debugging flag in this stream's TarBuffer.
voidsetDebug(boolean debugF)
Sets the debugging flag.
voidsetLongFileMode(int longFileMode)
voidwrite(int b)
Writes a byte to the current tar archive entry.
voidwrite(byte[] wBuf)
Writes bytes to the current tar archive entry.
voidwrite(byte[] wBuf, int wOffset, int numToWrite)
Writes bytes to the current tar archive entry.
voidwriteEOFRecord()
Write an EOF (end of archive) record to the tar archive.

Field Detail

assemBuf

protected byte[] assemBuf

assemLen

protected int assemLen

buffer

protected TarBuffer buffer

currBytes

protected int currBytes

currSize

protected int currSize

debug

protected boolean debug

longFileMode

protected int longFileMode

LONGFILE_ERROR

public static final int LONGFILE_ERROR
Fail if a long file name is required in the archive.

LONGFILE_GNU

public static final int LONGFILE_GNU
GNU tar extensions are used to store long file names in the archive.

LONGFILE_TRUNCATE

public static final int LONGFILE_TRUNCATE
Long paths will be truncated in the archive.

oneBuf

protected byte[] oneBuf

recordBuf

protected byte[] recordBuf

Constructor Detail

TarOutputStream

public TarOutputStream(OutputStream os)

TarOutputStream

public TarOutputStream(OutputStream os, int blockSize)

TarOutputStream

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

Method Detail

close

public void close()
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()
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()
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)
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: debug True to turn on debugging.

setDebug

public void setDebug(boolean debugF)
Sets the debugging flag.

Parameters: debugF True to turn on debugging.

setLongFileMode

public void setLongFileMode(int longFileMode)

write

public void write(int b)
Writes a byte to the current tar archive entry.

This method simply calls read( byte[], int, int ).

Parameters: b The byte written.

write

public void write(byte[] wBuf)
Writes bytes to the current tar archive entry.

This method simply calls write( byte[], int, int ).

Parameters: wBuf The buffer to write to the archive.

write

public void write(byte[] wBuf, int wOffset, int numToWrite)
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.

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.

writeEOFRecord

private void writeEOFRecord()
Write an EOF (end of archive) record to the tar archive. An EOF record consists of a record of all zeros.