Class TarGzOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
org.jboss.shrinkwrap.impl.base.io.tar.TarOutputStreamImpl
org.jboss.shrinkwrap.impl.base.io.tar.TarGzOutputStream
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ByteArrayOutputStreamprivate TarEntryprivate GZIPOutputStreamprivate TarOutputStreamImplFields inherited from class org.jboss.shrinkwrap.impl.base.io.tar.TarOutputStreamImpl
assemBuf, assemLen, buffer, currBytes, currSize, debug, oneBuf, recordBufFields inherited from class java.io.FilterOutputStream
out -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Ends the TAR archive and closes the underlying OutputStream.voidClose an entry.voidfinish()Ends the TAR archive without closing the underlying OutputStream.voidflush()intGet the record size being used by this stream's TarBuffer.voidputNextEntry(TarEntry entry) Put an entry on the output stream.voidsetBufferDebug(boolean b) Sets the debugging flag in this stream's TarBuffer.voidsetDebug(boolean b) Sets the debugging flag.voidwrite(byte[] b) Writes bytes to the current tar archive entry.voidwrite(byte[] b, int start, int length) Writes bytes to the current tar archive entry.voidwrite(int b) Writes a byte to the current tar archive entry.
-
Field Details
-
tos
-
gzip
-
bos
-
currentEntry
-
-
Constructor Details
-
TarGzOutputStream
- Throws:
IOException
-
-
Method Details
-
setDebug
public void setDebug(boolean b) Description copied from class:TarOutputStreamImplSets the debugging flag.- Overrides:
setDebugin classTarOutputStreamImpl- Parameters:
b- True to turn on debugging.
-
setBufferDebug
public void setBufferDebug(boolean b) Description copied from class:TarOutputStreamImplSets the debugging flag in this stream's TarBuffer.- Overrides:
setBufferDebugin classTarOutputStreamImpl
-
finish
Description copied from class:TarOutputStreamImplEnds the TAR archive without closing the underlying OutputStream. The result is that the EOF record of nulls is written.- Overrides:
finishin classTarOutputStreamImpl- Throws:
IOException
-
close
Description copied from class:TarOutputStreamImplEnds the TAR archive and closes the underlying OutputStream. This means that finish() is called followed by calling the TarBuffer's close().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classTarOutputStreamImpl- Throws:
IOException
-
getRecordSize
public int getRecordSize()Description copied from class:TarOutputStreamImplGet the record size being used by this stream's TarBuffer.- Overrides:
getRecordSizein classTarOutputStreamImpl- Returns:
- The TarBuffer record size.
-
putNextEntry
Description copied from class:TarOutputStreamImplPut 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:
putNextEntryin classTarOutputStreamImpl- Parameters:
entry- The TarEntry to be written to the archive.- Throws:
IOException
-
closeEntry
Description copied from class:TarOutputStreamImplClose 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:
closeEntryin classTarOutputStreamImpl- Throws:
IOException
-
write
Description copied from class:TarOutputStreamImplWrites a byte to the current tar archive entry. This method simply calls read( byte[], int, int ).- Overrides:
writein classTarOutputStreamImpl- Parameters:
b- The byte written.- Throws:
IOException
-
write
Description copied from class:TarOutputStreamImplWrites bytes to the current tar archive entry. This method simply calls read( byte[], int, int ).- Overrides:
writein classTarOutputStreamImpl- Parameters:
b- The buffer to write to the archive.- Throws:
IOException
-
write
Description copied from class:TarOutputStreamImplWrites 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:
writein classTarOutputStreamImpl- 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:
IOException
-
flush
- Specified by:
flushin interfaceFlushable- Overrides:
flushin classFilterOutputStream- Throws:
IOException- See Also:
-