| java.lang.Object
 java.io.InputStream
java.io.FilterInputStream
org.apache.tools.tar.TarInputStream
| TarInputStream | | public class TarInputStream extends FilterInputStream (Code) | | 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().
|
| Method Summary | |
| public int | available()
Get the available data that can be read from the current
entry in the archive. | | public void | close()
Closes this stream. | | public void | copyEntryContents(OutputStream out)
Copies the contents of the current tar archive entry directly into
an output stream. | | public TarEntry | getNextEntry()
Get the next entry in this tar archive. | | public int | getRecordSize()
Get the record size being used by this stream's TarBuffer. | | public void | mark(int markLimit)
Since we do not support marking just yet, we do nothing. | | public boolean | markSupported()
Since we do not support marking just yet, we return false. | | public int | read()
Reads a byte from the current tar archive entry. | | public int | read(byte[] buf, int offset, int numToRead)
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.
Parameters:
buf - The buffer into which to place bytes read.
Parameters:
offset - The offset at which to place bytes read.
Parameters:
numToRead - The number of bytes to read. | | public void | reset()
Since we do not support marking just yet, we do nothing. | | public void | setDebug(boolean debug)
Sets the debugging flag. | | public long | skip(long numToSkip)
Skip bytes in the input buffer. |
| debug | | protected boolean debug(Code) | | |
| entryOffset | | protected long entryOffset(Code) | | |
| entrySize | | protected long entrySize(Code) | | |
| hasHitEOF | | protected boolean hasHitEOF(Code) | | |
| oneBuf | | protected byte[] oneBuf(Code) | | 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(Code) | | |
| TarInputStream | | public TarInputStream(InputStream is)(Code) | | Constructor for TarInputStream.
Parameters:
is - the input stream to use |
| TarInputStream | | public TarInputStream(InputStream is, int blockSize)(Code) | | Constructor for TarInputStream.
Parameters:
is - the input stream to use
Parameters:
blockSize - the block size to use |
| TarInputStream | | public TarInputStream(InputStream is, int blockSize, int recordSize)(Code) | | Constructor for TarInputStream.
Parameters:
is - the input stream to use
Parameters:
blockSize - the block size to use
Parameters:
recordSize - the record size to use |
| available | | public int available() throws IOException(Code) | | 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.
Integer.MAX_VALUE is returen in case more than Integer.MAX_VALUE
bytes are left in the current entry in the archive.
The number of available bytes for the current entry.
throws:
IOException - for signature |
| copyEntryContents | | public void copyEntryContents(OutputStream out) throws IOException(Code) | | Copies the contents of the current tar archive entry directly into
an output stream.
Parameters:
out - The OutputStream into which to write the entry's data.
throws:
IOException - on error |
| getNextEntry | | public TarEntry getNextEntry() throws IOException(Code) | | 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.
throws:
IOException - on error |
| getRecordSize | | public int getRecordSize()(Code) | | Get the record size being used by this stream's TarBuffer.
The TarBuffer record size. |
| mark | | public void mark(int markLimit)(Code) | | Since we do not support marking just yet, we do nothing.
Parameters:
markLimit - The limit to mark. |
| markSupported | | public boolean markSupported()(Code) | | Since we do not support marking just yet, we return false.
False. |
| read | | public int read() throws IOException(Code) | | Reads a byte from the current tar archive entry.
This method simply calls read( byte[], int, int ).
The byte read, or -1 at EOF.
throws:
IOException - on error |
| read | | public int read(byte[] buf, int offset, int numToRead) throws IOException(Code) | | 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.
Parameters:
buf - The buffer into which to place bytes read.
Parameters:
offset - The offset at which to place bytes read.
Parameters:
numToRead - The number of bytes to read. The number of bytes read, or -1 at EOF.
throws:
IOException - on error |
| reset | | public void reset()(Code) | | Since we do not support marking just yet, we do nothing.
|
| setDebug | | public void setDebug(boolean debug)(Code) | | Sets the debugging flag.
Parameters:
debug - True to turn on debugging. |
| skip | | public long skip(long numToSkip) throws IOException(Code) | | 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.
Parameters:
numToSkip - The number of bytes to skip. the number actually skipped
throws:
IOException - on error |
|
|