| java.lang.Object
 java.io.InputStream
java.io.FilterInputStream
org.apache.commons.vfs.provider.tar.TarInputStream
| Constructor Summary | |
| | TarInputStream(InputStream input)
Construct a TarInputStream using specified input
stream and default block and record sizes. | | | TarInputStream(InputStream input, int blockSize)
Construct a TarInputStream using specified input
stream, block size and default record sizes. | | | TarInputStream(InputStream input, int blockSize, int recordSize)
Construct a TarInputStream using specified input
stream, block size and record sizes. |
| 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 output)
Copies the contents of the current tar archive entry directly into an
output stream. | | protected void | debug(String message)
Utility method to do debugging. | | 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[] buffer)
Reads bytes from the current tar archive entry. | | public int | read(byte[] buffer, int offset, int count)
Reads bytes from the current tar archive entry. | | public void | reset()
Since we do not support marking just yet, we do nothing. | | public void | setDebug(boolean debug)
Sets the debugging flag. | | public void | skip(int numToSkip)
Skip bytes in the input buffer. |
| TarInputStream | | TarInputStream(InputStream input, int blockSize)(Code) | | Construct a TarInputStream using specified input
stream, block size and default record sizes.
Parameters:
input - stream to create TarInputStream from
Parameters:
blockSize - the block size to use
See Also: TarBuffer.DEFAULT_RECORDSIZE |
| TarInputStream | | TarInputStream(InputStream input, int blockSize, int recordSize)(Code) | | Construct a TarInputStream using specified input
stream, block size and record sizes.
Parameters:
input - stream to create TarInputStream from
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.
The number of available bytes for the current entry.
exception:
IOException - when an IO error causes operation to fail |
| close | | public void close() throws IOException(Code) | | Closes this stream. Calls the TarBuffer's close() method.
exception:
IOException - when an IO error causes operation to fail |
| copyEntryContents | | public void copyEntryContents(OutputStream output) throws IOException(Code) | | Copies the contents of the current tar archive entry directly into an
output stream.
Parameters:
output - The OutputStream into which to write the entry's data.
exception:
IOException - when an IO error causes operation to fail |
| debug | | protected void debug(String message)(Code) | | Utility method to do debugging.
Capable of being overidden in sub-classes.
Parameters:
message - the message to use in debugging |
| 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.
exception:
IOException - Description of Exception |
| 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.
exception:
IOException - when an IO error causes operation to fail |
| read | | public int read(byte[] buffer) throws IOException(Code) | | Reads bytes from the current tar archive entry. This method simply calls
read( byte[], int, int ).
Parameters:
buffer - The buffer into which to place bytes read. The number of bytes read, or -1 at EOF.
exception:
IOException - when an IO error causes operation to fail |
| read | | public int read(byte[] buffer, int offset, int count) 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:
buffer - The buffer into which to place bytes read.
Parameters:
offset - The offset at which to place bytes read.
Parameters:
count - The number of bytes to read. The number of bytes read, or -1 at EOF.
exception:
IOException - when an IO error causes operation to fail |
| 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 - The new Debug value |
| skip | | public void skip(int 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.
exception:
IOException - when an IO error causes operation to fail |
|
|