com.facebook.buck.util.zip

Class OverwritingZipOutputStreamImpl

java.lang.Object

com.facebook.buck.util.zip.OverwritingZipOutputStreamImpl

All Implemented Interfaces:

CustomZipOutputStream.Impl

public class OverwritingZipOutputStreamImpl
extends Object
implements CustomZipOutputStream.Impl

An implementation of an OutputStream for zip files that allows newer entries to overwrite or refresh previously written entries.

This class works by spooling the bytes of each entry to a temporary holding file named after the name of the ZipEntry being stored. Once the stream is closed, these files are spooled off disk and written to the OutputStream given to the constructor.

Constructor Summary

Constructors

Constructor and Description
OverwritingZipOutputStreamImpl(Clock clock, OutputStream out)

Method Summary

Modifier and Type	Method and Description
void	actuallyClose()
void	actuallyCloseEntry() Called by CustomZipOutputStream.close() and used by impls to close the delegate stream.
void	actuallyPutNextEntry(ZipEntry entry) Called by CustomZipOutputStream.putNextEntry(ZipEntry) and used by impls to put the next entry into the zip file.
void	actuallyWrite(byte[] b, int off, int len) Called by CustomZipOutputStream.write(byte[], int, int) only once it is known that the stream has not been closed, and that a ZipEntry has already been put on the stream and not closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

OverwritingZipOutputStreamImpl

public OverwritingZipOutputStreamImpl(Clock clock,
                                      OutputStream out)

Method Detail

actuallyPutNextEntry

public void actuallyPutNextEntry(ZipEntry entry)
                          throws IOException

Description copied from interface: CustomZipOutputStream.Impl

Called by CustomZipOutputStream.putNextEntry(ZipEntry) and used by impls to put the next entry into the zip file. It is guaranteed that the entry won't be null and the stream will be open. It is also guaranteed that there's no current entry open.

Specified by:

actuallyPutNextEntry in interface CustomZipOutputStream.Impl

Parameters:

entry - The ZipEntry to write.

Throws:

IOException

actuallyCloseEntry

public void actuallyCloseEntry()
                        throws IOException

Description copied from interface: CustomZipOutputStream.Impl

Called by CustomZipOutputStream.close() and used by impls to close the delegate stream. This method will be called at most once in the lifecycle of the CustomZipOutputStream.

Specified by:

actuallyCloseEntry in interface CustomZipOutputStream.Impl

Throws:

IOException

actuallyWrite

public void actuallyWrite(byte[] b,
                          int off,
                          int len)
                   throws IOException

Description copied from interface: CustomZipOutputStream.Impl

Called by CustomZipOutputStream.write(byte[], int, int) only once it is known that the stream has not been closed, and that a ZipEntry has already been put on the stream and not closed.

Specified by:

actuallyWrite in interface CustomZipOutputStream.Impl

Throws:

IOException

actuallyClose

public void actuallyClose()
                   throws IOException

Specified by:

actuallyClose in interface CustomZipOutputStream.Impl

Throws:

IOException