com.ice.tar
Class TarGzOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.FilterOutputStream
          extended by com.ice.tar.TarOutputStream
              extended by com.ice.tar.TarGzOutputStream
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable

public class TarGzOutputStream
extends TarOutputStream

Outputs tar.gz files. Added functionality that it doesn't need to know the size of an entry. If an entry has zero size when it is put in the Tar, then it buffers it until it's closed and it knows the size.

Author:
"Bay"

Field Summary
 
Fields inherited from class com.ice.tar.TarOutputStream
assemBuf, assemLen, buffer, currBytes, currSize, debug, oneBuf, recordBuf
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
TarGzOutputStream(java.io.OutputStream out)
           
 
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 b)
          Sets the debugging flag in this stream's TarBuffer.
 void setDebug(boolean b)
          Sets the debugging flag.
 void write(byte[] b)
          Writes bytes to the current tar archive entry.
 void write(byte[] b, int start, int length)
          Writes bytes to the current tar archive entry.
 void write(int b)
          Writes a byte to the current tar archive entry.
 
Methods inherited from class java.io.FilterOutputStream
flush
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TarGzOutputStream

public TarGzOutputStream(java.io.OutputStream out)
                  throws java.io.IOException
Throws:
java.io.IOException
Method Detail

setDebug

public void setDebug(boolean b)
Description copied from class: TarOutputStream
Sets the debugging flag.

Overrides:
setDebug in class TarOutputStream
Parameters:
b - True to turn on debugging.

setBufferDebug

public void setBufferDebug(boolean b)
Description copied from class: TarOutputStream
Sets the debugging flag in this stream's TarBuffer.

Overrides:
setBufferDebug in class TarOutputStream

finish

public void finish()
            throws java.io.IOException
Description copied from class: TarOutputStream
Ends the TAR archive without closing the underlying OutputStream. The result is that the EOF record of nulls is written.

Overrides:
finish in class TarOutputStream
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Description copied from class: TarOutputStream
Ends the TAR archive and closes the underlying OutputStream. This means that finish() is called followed by calling the TarBuffer's close().

Specified by:
close in interface java.io.Closeable
Overrides:
close in class TarOutputStream
Throws:
java.io.IOException

getRecordSize

public int getRecordSize()
Description copied from class: TarOutputStream
Get the record size being used by this stream's TarBuffer.

Overrides:
getRecordSize in class TarOutputStream
Returns:
The TarBuffer record size.

putNextEntry

public void putNextEntry(TarEntry entry)
                  throws java.io.IOException
Description copied from class: TarOutputStream
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.

Overrides:
putNextEntry in class TarOutputStream
Parameters:
entry - The TarEntry to be written to the archive.
Throws:
java.io.IOException

closeEntry

public void closeEntry()
                throws java.io.IOException
Description copied from class: TarOutputStream
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.

Overrides:
closeEntry in class TarOutputStream
Throws:
java.io.IOException

write

public void write(int b)
           throws java.io.IOException
Description copied from class: TarOutputStream
Writes a byte to the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:
write in class TarOutputStream
Parameters:
b - The byte written.
Throws:
java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException
Description copied from class: TarOutputStream
Writes bytes to the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:
write in class TarOutputStream
Parameters:
b - The buffer to write to the archive.
Throws:
java.io.IOException

write

public void write(byte[] b,
                  int start,
                  int length)
           throws java.io.IOException
Description copied from class: TarOutputStream
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 ).

Overrides:
write in class TarOutputStream
Parameters:
b - The buffer to write to the archive.
start - The offset in the buffer from which to get bytes.
length - The number of bytes to write.
Throws:
java.io.IOException


This software has been placed into the public domain.