Maven module :un.storage : archive-tar :
Class : un.storage.archive.tar.TarInputStream
Extends/Implements : un.api.io.WrapInputStream
Subclasses : -

The TarInputStream reads a UNIX tar archive as an InputStream. methods are
provided to position at each successive entry in the archive, and the read
each entry as a normal input stream using read().
Kerry Menzel Contributed the code to support file sizes
greater than 2GB (longs versus ints).
author  Timothy Gerard Endres,

Variables : oneBuf, hasHitEOF, entrySize, entryOffset, readBuf, buffer, currEntry
Functions : TarInputStream, TarInputStream, TarInputStream, close, getRecordSize, available, skip, getEntryPosition, getStreamPosition, getNextEntry, read, read, read, copyEntryContents

protected byte[] oneBuf

protected boolean hasHitEOF

protected long entrySize

protected long entryOffset

protected byte[] readBuf

protected TarBuffer buffer

protected TarEntry currEntry

public void TarInputStream (ByteInputStream is)

public void TarInputStream (ByteInputStream is, int blockSize)

public void TarInputStream (ByteInputStream is, int blockSize, int recordSize)


Closes this stream. Calls the TarBuffer's close() method.
public void close ()


Get the record size being used by this stream's TarBuffer.
return  The TarBuffer record size.
public int getRecordSize ()


Get the available data that can be read from the current entry in the
archive. This does not indicate how much data is left in the entire
archive, only in the current entry. This value is determined from the
entry's size header field and the amount of data already read from the
current entry.
return  The number of available bytes for the current entry.
public int available ()


Skip bytes in the input buffer. This skips bytes in the current entry's
data, not the entire archive, and will stop at the end of the current
entry's data if the number to skip extends beyond that point.

@param numToSkip The number of bytes to skip.
@return The actual number of bytes skipped.
public long skip (long numToSkip)


Get the number of bytes into the current TarEntry. This method returns
the number of bytes that have been read from the current TarEntry's data.
returns  The current entry offset.
public long getEntryPosition ()


Get the number of bytes into the stream we are currently at. This method
accounts for the blocking stream that tar uses, so it represents the
actual position in input stream, as opposed to the place where the tar
archive parsing is.
returns  The current file pointer.
public long getStreamPosition ()


Get the next entry in this tar archive. This will skip over any remaining
data in the current entry, if there is one, and place the input stream at
the header of the next entry, and read the header and instantiate a new
TarEntry from the header bytes and return that entry. If there are no
more entries in the archive, null will be returned to indicate that the
end of the archive has been reached.
return  The next TarEntry in the archive, or null.
public TarEntry getNextEntry ()


Reads a byte from the current tar archive entry.
This method simply calls read( byte[], int, int ).
return  The byte read, or -1 at EOF.
public int read ()


Reads bytes from the current tar archive entry.
This method simply calls read( byte[], int, int ).
param  buf The buffer into which to place bytes read.
return  The number of bytes read, or -1 at EOF.
public int read (byte[] buf)


Reads bytes from the current tar archive entry.
This method is aware of the boundaries of the current entry in the
archive and will deal with them as if they were this stream's start and
EOF.
param  buf The buffer into which to place bytes read.
param  offset The offset at which to place bytes read.
param  numToRead The number of bytes to read.
return  The number of bytes read, or -1 at EOF.
public int read (byte[] buf, int offset, int numToRead)


Copies the contents of the current tar archive entry directly into an
output stream.
param  out The OutputStream into which to write the entry's data.
public void copyEntryContents (ByteOutputStream out)