org.apache.tools.tar
Class TarInputStream
FilterInputStream
org.apache.tools.tar.TarInputStream
public class TarInputStream
extends FilterInputStream
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().
TarInputStream(InputStream is) - Constructor for TarInputStream.
|
TarInputStream(InputStream is, int blockSize) - Constructor for TarInputStream.
|
TarInputStream(InputStream is, int blockSize, int recordSize) - Constructor for TarInputStream.
|
int | available() - Get the available data that can be read from the current
entry in the archive.
|
void | close() - Closes this stream.
|
void | copyEntryContents(OutputStream out) - Copies the contents of the current tar archive entry directly into
an output stream.
|
TarEntry | getNextEntry() - Get the next entry in this tar archive.
|
int | getRecordSize() - Get the record size being used by this stream's TarBuffer.
|
void | mark(int markLimit) - Since we do not support marking just yet, we do nothing.
|
boolean | markSupported() - Since we do not support marking just yet, we return false.
|
int | read() - Reads a byte from the current tar archive entry.
|
int | read(byte[] buf, int offset, int numToRead) - Reads bytes from the current tar archive entry.
|
void | reset() - Since we do not support marking just yet, we do nothing.
|
void | setDebug(boolean debug) - Sets the debugging flag.
|
long | skip(long numToSkip) - Skip bytes in the input buffer.
|
debug
protected boolean debug
entryOffset
protected int entryOffset
entrySize
protected int entrySize
hasHitEOF
protected boolean hasHitEOF
oneBuf
protected byte[] oneBuf
This contents of this array is not used at all in this class,
it is only here to avoid repreated object creation during calls
to the no-arg read method.
readBuf
protected byte[] readBuf
TarInputStream
public TarInputStream(InputStream is)
Constructor for TarInputStream.
is
- the input stream to use
TarInputStream
public TarInputStream(InputStream is,
int blockSize)
Constructor for TarInputStream.
is
- the input stream to useblockSize
- the block size to use
TarInputStream
public TarInputStream(InputStream is,
int blockSize,
int recordSize)
Constructor for TarInputStream.
is
- the input stream to useblockSize
- the block size to userecordSize
- the record size to use
available
public int available()
throws IOException
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.
- The number of available bytes for the current entry.
close
public void close()
throws IOException
Closes this stream. Calls the TarBuffer's close() method.
copyEntryContents
public void copyEntryContents(OutputStream out)
throws IOException
Copies the contents of the current tar archive entry directly into
an output stream.
out
- The OutputStream into which to write the entry's data.
getNextEntry
public TarEntry getNextEntry()
throws IOException
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.
- The next TarEntry in the archive, or null.
getRecordSize
public int getRecordSize()
Get the record size being used by this stream's TarBuffer.
- The TarBuffer record size.
mark
public void mark(int markLimit)
Since we do not support marking just yet, we do nothing.
markLimit
- The limit to mark.
markSupported
public boolean markSupported()
Since we do not support marking just yet, we return false.
- False.
read
public int read()
throws IOException
Reads a byte from the current tar archive entry.
This method simply calls read( byte[], int, int ).
- The byte read, or -1 at EOF.
read
public int read(byte[] buf,
int offset,
int numToRead)
throws IOException
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.
buf
- The buffer into which to place bytes read.offset
- The offset at which to place bytes read.numToRead
- The number of bytes to read.
- The number of bytes read, or -1 at EOF.
reset
public void reset()
Since we do not support marking just yet, we do nothing.
setDebug
public void setDebug(boolean debug)
Sets the debugging flag.
debug
- True to turn on debugging.
skip
public long skip(long numToSkip)
throws IOException
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.
numToSkip
- The number of bytes to skip.
- the number actually skipped
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.