Package org.apache.tools.tar
Class TarBuffer
- java.lang.Object
- 
- org.apache.tools.tar.TarBuffer
 
- 
 public class TarBuffer extends java.lang.ObjectThe 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. 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDEFAULT_BLKSIZEDefault block sizestatic intDEFAULT_RCDSIZEDefault record size
 - 
Constructor SummaryConstructors Constructor 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.
 - 
Method SummaryModifier and Type Method Description voidclose()Close the TarBuffer.intgetBlockSize()Get the TAR Buffer's block size.intgetCurrentBlockNum()Get the current block number, zero based.intgetCurrentRecordNum()Get the current record number, within the current block, zero based.intgetRecordSize()Get the TAR Buffer's record size.booleanisEOFRecord(byte[] record)Determine if an archive record indicate End of Archive.byte[]readRecord()Read a record from the input stream and return the data.voidsetDebug(boolean debug)Set the debugging flag for the buffer.voidskipRecord()Skip over a record on the input stream.voidwriteRecord(byte[] record)Write an archive record to the archive.voidwriteRecord(byte[] buf, int offset)Write an archive record to the archive, where the record may be inside of a larger array buffer.
 
- 
- 
- 
Field Detail- 
DEFAULT_RCDSIZEpublic static final int DEFAULT_RCDSIZE Default record size- See Also:
- Constant Field Values
 
 - 
DEFAULT_BLKSIZEpublic static final int DEFAULT_BLKSIZE Default block size- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
TarBufferpublic TarBuffer(java.io.InputStream inStream) Constructor for a TarBuffer on an input stream.- Parameters:
- inStream- the input stream to use
 
 - 
TarBufferpublic TarBuffer(java.io.InputStream inStream, int blockSize)Constructor for a TarBuffer on an input stream.- Parameters:
- inStream- the input stream to use
- blockSize- the block size to use
 
 - 
TarBufferpublic TarBuffer(java.io.InputStream inStream, int blockSize, int recordSize)Constructor for a TarBuffer on an input stream.- Parameters:
- inStream- the input stream to use
- blockSize- the block size to use
- recordSize- the record size to use
 
 - 
TarBufferpublic TarBuffer(java.io.OutputStream outStream) Constructor for a TarBuffer on an output stream.- Parameters:
- outStream- the output stream to use
 
 - 
TarBufferpublic TarBuffer(java.io.OutputStream outStream, int blockSize)Constructor for a TarBuffer on an output stream.- Parameters:
- outStream- the output stream to use
- blockSize- the block size to use
 
 - 
TarBufferpublic TarBuffer(java.io.OutputStream outStream, int blockSize, int recordSize)Constructor for a TarBuffer on an output stream.- Parameters:
- outStream- the output stream to use
- blockSize- the block size to use
- recordSize- the record size to use
 
 
- 
 - 
Method Detail- 
getBlockSizepublic int getBlockSize() Get the TAR Buffer's block size. Blocks consist of multiple records.- Returns:
- the block size
 
 - 
getRecordSizepublic int getRecordSize() Get the TAR Buffer's record size.- Returns:
- the record size
 
 - 
setDebugpublic void setDebug(boolean debug) Set the debugging flag for the buffer.- Parameters:
- debug- If true, print debugging output.
 
 - 
isEOFRecordpublic boolean isEOFRecord(byte[] record) 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.
- Returns:
- true if the record data is an End of Archive
 
 - 
skipRecordpublic void skipRecord() throws java.io.IOExceptionSkip over a record on the input stream.- Throws:
- java.io.IOException- on error
 
 - 
readRecordpublic byte[] readRecord() throws java.io.IOExceptionRead a record from the input stream and return the data.- Returns:
- The record data.
- Throws:
- java.io.IOException- on error
 
 - 
getCurrentBlockNumpublic int getCurrentBlockNum() Get the current block number, zero based.- Returns:
- The current zero based block number.
 
 - 
getCurrentRecordNumpublic int getCurrentRecordNum() Get the current record number, within the current block, zero based. Thus, current offset = (currentBlockNum * recsPerBlk) + currentRecNum.- Returns:
- The current zero based record number.
 
 - 
writeRecordpublic void writeRecord(byte[] record) throws java.io.IOExceptionWrite an archive record to the archive.- Parameters:
- record- The record data to write to the archive.
- Throws:
- java.io.IOException- on error
 
 - 
writeRecordpublic void writeRecord(byte[] buf, int offset) throws java.io.IOExceptionWrite 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:
- buf- The buffer containing the record data to write.
- offset- The offset of the record data within buf.
- Throws:
- java.io.IOException- on error
 
 - 
closepublic void close() throws java.io.IOExceptionClose the TarBuffer. If this is an output buffer, also flush the current block before closing.- Throws:
- java.io.IOException- on error
 
 
- 
 
-