org.apache.tools.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().
Field Summary
protected byte[]assemBuf
protected intassemLen
protected TarBufferbuffer
protected longcurrBytes
protected StringcurrName
protected longcurrSize
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)
Constructor for TarInputStream.
TarOutputStream(OutputStream os, int blockSize)
Constructor for TarInputStream.
TarOutputStream(OutputStream os, int blockSize, int recordSize)
Constructor for TarInputStream.
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)
Set the long file mode.
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.

Field Detail

assemBuf

protected byte[] assemBuf

assemLen

protected int assemLen

buffer

protected TarBuffer buffer

currBytes

protected long currBytes

currName

protected String currName

currSize

protected long 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)
Constructor for TarInputStream.

Parameters: os the output stream to use

TarOutputStream

public TarOutputStream(OutputStream os, int blockSize)
Constructor for TarInputStream.

Parameters: os the output stream to use blockSize the block size to use

TarOutputStream

public TarOutputStream(OutputStream os, int blockSize, int recordSize)
Constructor for TarInputStream.

Parameters: os the output stream to use blockSize the block size to use recordSize the record size to use

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

Throws: IOException on error

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.

Throws: IOException on error

finish

public void finish()
Ends the TAR archive without closing the underlying OutputStream. The result is that the two EOF records of nulls are written.

Throws: IOException on error

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.

Throws: IOException on error

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)
Set the long file mode. This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2). This specifies the treatment of long file names (names >= TarConstants.NAMELEN). Default is LONGFILE_ERROR.

Parameters: longFileMode the mode to use

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.

Throws: IOException on error

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.

Throws: IOException on error

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.

Throws: IOException on error