| java.lang.Object
 org.apache.commons.vfs.provider.tar.TarBuffer
| TarBuffer | | class TarBuffer (Code) | | The TarBuffer class implements the tar archive concept of a buffered input
stream. This concept goes back to the days of blocked tape drives and special
io devices. In the Java universe, the only real function that this class
performs is to ensure that files have the correct "block" size, or other tars
will complain.
You should never have a need to access this class directly. TarBuffers are
created by Tar IO Streams.
author:
Timothy Gerard Endres
author:
Peter Donald
version:
$Revision: 480428 $ $Date: 2006-11-28 22:15:24 -0800 (Tue, 28 Nov 2006) $ |
| Method Summary | |
| public void | close()
Close the TarBuffer. | | protected void | debug(String message)
| | public int | getBlockSize()
Get the TAR Buffer's block size. | | public int | getCurrentBlockNum()
Get the current block number, zero based. | | public int | getCurrentRecordNum()
Get the current record number, within the current block, zero based. | | public int | getRecordSize()
Get the TAR Buffer's record size. | | public boolean | isEOFRecord(byte[] record)
Determine if an archive record indicate End of Archive. | | public byte[] | readRecord()
Read a record from the input stream and return the data. | | public void | setDebug(boolean debug)
Set the debugging flag for the buffer. | | public void | skipRecord()
Skip over a record on the input stream. | | public void | writeRecord(byte[] record)
Write an archive record to the archive. | | public void | writeRecord(byte[] buffer, int offset)
Write an archive record to the archive, where the record may be inside of
a larger array buffer. |
| DEFAULT_BLOCKSIZE | | final public static int DEFAULT_BLOCKSIZE(Code) | | |
| DEFAULT_RECORDSIZE | | final public static int DEFAULT_RECORDSIZE(Code) | | |
| close | | public void close() throws IOException(Code) | | Close the TarBuffer. If this is an output buffer, also flush the current
block before closing.
|
| getBlockSize | | public int getBlockSize()(Code) | | Get the TAR Buffer's block size. Blocks consist of multiple records.
The BlockSize value |
| getCurrentBlockNum | | public int getCurrentBlockNum()(Code) | | Get the current block number, zero based.
The current zero based block number. |
| getCurrentRecordNum | | public int getCurrentRecordNum()(Code) | | Get the current record number, within the current block, zero based.
Thus, current offset = (currentBlockNum * recsPerBlk) + currentRecNum.
The current zero based record number. |
| getRecordSize | | public int getRecordSize()(Code) | | Get the TAR Buffer's record size.
The RecordSize value |
| isEOFRecord | | public boolean isEOFRecord(byte[] record)(Code) | | Determine if an archive record indicate End of Archive. End of archive is
indicated by a record that consists entirely of null bytes.
Parameters:
record - The record data to check. The EOFRecord value |
| readRecord | | public byte[] readRecord() throws IOException(Code) | | Read a record from the input stream and return the data.
The record data.
exception:
IOException - Description of Exception |
| setDebug | | public void setDebug(boolean debug)(Code) | | Set the debugging flag for the buffer.
Parameters:
debug - If true, print debugging output. |
| skipRecord | | public void skipRecord() throws IOException(Code) | | Skip over a record on the input stream.
|
| writeRecord | | public void writeRecord(byte[] record) throws IOException(Code) | | Write an archive record to the archive.
Parameters:
record - The record data to write to the archive. |
| writeRecord | | public void writeRecord(byte[] buffer, int offset) throws IOException(Code) | | Write an archive record to the archive, where the record may be inside of
a larger array buffer. The buffer must be "offset plus record size" long.
Parameters:
buffer - The buffer containing the record data to write.
Parameters:
offset - The offset of the record data within buf. |
|
|