public class TarBuffer
extends java.lang.Object
You should never have a need to access this class directly. TarBuffers are created by Tar IO Streams.
| Modifier and Type | Field and Description | 
|---|---|
| static int | DEFAULT_BLKSIZEDefault block size | 
| static int | DEFAULT_RCDSIZEDefault record size | 
| Constructor and Description | 
|---|
| TarBuffer(java.io.InputStream inStream)Constructor for a TarBuffer on an input stream. | 
| TarBuffer(java.io.InputStream inStream,
         int blockSize)Constructor for a TarBuffer on an input stream. | 
| TarBuffer(java.io.InputStream inStream,
         int blockSize,
         int recordSize)Constructor for a TarBuffer on an input stream. | 
| TarBuffer(java.io.OutputStream outStream)Constructor for a TarBuffer on an output stream. | 
| TarBuffer(java.io.OutputStream outStream,
         int blockSize)Constructor for a TarBuffer on an output stream. | 
| TarBuffer(java.io.OutputStream outStream,
         int blockSize,
         int recordSize)Constructor for a TarBuffer on an output stream. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | close()Close the TarBuffer. | 
| int | getBlockSize()Get the TAR Buffer's block size. | 
| int | getCurrentBlockNum()Get the current block number, zero based. | 
| int | getCurrentRecordNum()Get the current record number, within the current block, zero based. | 
| int | getRecordSize()Get the TAR Buffer's record size. | 
| boolean | isEOFRecord(byte[] record)Determine if an archive record indicate End of Archive. | 
| byte[] | readRecord()Read a record from the input stream and return the data. | 
| void | setDebug(boolean debug)Set the debugging flag for the buffer. | 
| void | skipRecord()Skip over a record on the input stream. | 
| void | writeRecord(byte[] record)Write an archive record to the archive. | 
| void | writeRecord(byte[] buf,
           int offset)Write an archive record to the archive, where the record may be
 inside of a larger array buffer. | 
public static final int DEFAULT_RCDSIZE
public static final int DEFAULT_BLKSIZE
public TarBuffer(java.io.InputStream inStream)
inStream - the input stream to usepublic TarBuffer(java.io.InputStream inStream,
         int blockSize)
inStream - the input stream to useblockSize - the block size to usepublic TarBuffer(java.io.InputStream inStream,
         int blockSize,
         int recordSize)
inStream - the input stream to useblockSize - the block size to userecordSize - the record size to usepublic TarBuffer(java.io.OutputStream outStream)
outStream - the output stream to usepublic TarBuffer(java.io.OutputStream outStream,
         int blockSize)
outStream - the output stream to useblockSize - the block size to usepublic TarBuffer(java.io.OutputStream outStream,
         int blockSize,
         int recordSize)
outStream - the output stream to useblockSize - the block size to userecordSize - the record size to usepublic int getBlockSize()
public int getRecordSize()
public void setDebug(boolean debug)
debug - If true, print debugging output.public boolean isEOFRecord(byte[] record)
record - The record data to check.public void skipRecord()
                throws java.io.IOException
java.io.IOException - on errorpublic byte[] readRecord()
                  throws java.io.IOException
java.io.IOException - on errorpublic int getCurrentBlockNum()
public int getCurrentRecordNum()
public void writeRecord(byte[] record)
                 throws java.io.IOException
record - The record data to write to the archive.java.io.IOException - on errorpublic void writeRecord(byte[] buf,
               int offset)
                 throws java.io.IOException
buf - The buffer containing the record data to write.offset - The offset of the record data within buf.java.io.IOException - on errorpublic void close()
           throws java.io.IOException
java.io.IOException - on error