org.jboss.shrinkwrap.impl.base.io.tar

Class TarOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jboss.shrinkwrap.impl.base.io.tar.TarOutputStreamImpl

org.jboss.shrinkwrap.impl.base.io.tar.TarOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class TarOutputStream
extends TarOutputStreamImpl

Outputs TAR files; essentially a copy (ie. hack) of TarGzOutputStream, except the output is *not* encoded with a GZIPOutputStream wrapper. In place temporarily until we determine a way to properly write entries and automatically handle the proper "next entry" logic for TAR just as is done for TAR.GZ. Likely well centralize a lot of this logic into a common base class.

Author:

"Bay" , ALR

Field Summary

Fields inherited from class org.jboss.shrinkwrap.impl.base.io.tar.TarOutputStreamImpl

assemBuf, assemLen, buffer, currBytes, currSize, debug, oneBuf, recordBuf

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
TarOutputStream(OutputStream out)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	flush()
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.lang.Object

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

Constructor Detail

TarOutputStream

public TarOutputStream(OutputStream out)
                throws IOException

Throws:

IOException

Method Detail

setDebug

public void setDebug(boolean b)

Description copied from class: TarOutputStreamImpl

Sets the debugging flag.

Overrides:

setDebug in class TarOutputStreamImpl

Parameters:

b - True to turn on debugging.

setBufferDebug

public void setBufferDebug(boolean b)

Description copied from class: TarOutputStreamImpl

Sets the debugging flag in this stream's TarBuffer.

Overrides:

setBufferDebug in class TarOutputStreamImpl

finish

public void finish()
            throws IOException

Description copied from class: TarOutputStreamImpl

Ends the TAR archive without closing the underlying OutputStream. The result is that the EOF record of nulls is written.

Overrides:

finish in class TarOutputStreamImpl

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: TarOutputStreamImpl

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 Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class TarOutputStreamImpl

Throws:

IOException

getRecordSize

public int getRecordSize()

Description copied from class: TarOutputStreamImpl

Get the record size being used by this stream's TarBuffer.

Overrides:

getRecordSize in class TarOutputStreamImpl

Returns:

The TarBuffer record size.

putNextEntry

public void putNextEntry(TarEntry entry)
                  throws IOException

Description copied from class: TarOutputStreamImpl

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 TarOutputStreamImpl

Parameters:

entry - The TarEntry to be written to the archive.

Throws:

IOException

closeEntry

public void closeEntry()
                throws IOException

Description copied from class: TarOutputStreamImpl

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 TarOutputStreamImpl

Throws:

IOException

write

public void write(int b)
           throws IOException

Description copied from class: TarOutputStreamImpl

Writes a byte to the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:

write in class TarOutputStreamImpl

Parameters:

b - The byte written.

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Description copied from class: TarOutputStreamImpl

Writes bytes to the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:

write in class TarOutputStreamImpl

Parameters:

b - The buffer to write to the archive.

Throws:

IOException

write

public void write(byte[] b,
         int start,
         int length)
           throws IOException

Description copied from class: TarOutputStreamImpl

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 TarOutputStreamImpl

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

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

See Also:

FilterOutputStream.flush()