| java.lang.Object
 java.io.OutputStream
java.io.FilterOutputStream
org.apache.tools.tar.TarOutputStream
| TarOutputStream | | public class TarOutputStream extends FilterOutputStream (Code) | | The TarOutputStream writes a UNIX tar archive as an OutputStream.
Methods are provided to put entries, and then write their contents
by writing to this stream using write().
|
| Method Summary | |
| public void | close()
Ends the TAR archive and closes the underlying OutputStream. | | public void | closeEntry()
Close an entry. | | public void | finish()
Ends the TAR archive without closing the underlying OutputStream. | | public int | getRecordSize()
Get the record size being used by this stream's TarBuffer. | | public void | putNextEntry(TarEntry entry)
Put an entry on the output stream. | | public void | setBufferDebug(boolean debug)
Sets the debugging flag in this stream's TarBuffer. | | public void | setDebug(boolean debugF)
Sets the debugging flag. | | public void | setLongFileMode(int longFileMode)
Set the long file mode. | | public void | write(int b)
Writes a byte to the current tar archive entry. | | public void | write(byte[] wBuf)
Writes bytes to the current tar archive entry. | | public void | write(byte[] wBuf, int wOffset, int numToWrite)
Writes bytes to the current tar archive entry. |
| LONGFILE_ERROR | | final public static int LONGFILE_ERROR(Code) | | Fail if a long file name is required in the archive.
|
| LONGFILE_GNU | | final public static int LONGFILE_GNU(Code) | | GNU tar extensions are used to store long file names in the archive.
|
| LONGFILE_TRUNCATE | | final public static int LONGFILE_TRUNCATE(Code) | | Long paths will be truncated in the archive.
|
| assemBuf | | protected byte[] assemBuf(Code) | | |
| assemLen | | protected int assemLen(Code) | | |
| currBytes | | protected long currBytes(Code) | | |
| currSize | | protected long currSize(Code) | | |
| debug | | protected boolean debug(Code) | | |
| longFileMode | | protected int longFileMode(Code) | | |
| oneBuf | | protected byte[] oneBuf(Code) | | |
| recordBuf | | protected byte[] recordBuf(Code) | | |
| TarOutputStream | | public TarOutputStream(OutputStream os)(Code) | | Constructor for TarInputStream.
Parameters:
os - the output stream to use |
| TarOutputStream | | public TarOutputStream(OutputStream os, int blockSize)(Code) | | Constructor for TarInputStream.
Parameters:
os - the output stream to use
Parameters:
blockSize - the block size to use |
| TarOutputStream | | public TarOutputStream(OutputStream os, int blockSize, int recordSize)(Code) | | Constructor for TarInputStream.
Parameters:
os - the output stream to use
Parameters:
blockSize - the block size to use
Parameters:
recordSize - the record size to use |
| close | | public void close() throws IOException(Code) | | Ends the TAR archive and closes the underlying OutputStream.
This means that finish() is called followed by calling the
TarBuffer's close().
throws:
IOException - on error |
| closeEntry | | public void closeEntry() throws IOException(Code) | | Close an entry. This method MUST be called for all file
entries that contain data. The reason is that we must
buffer data written to the stream in order to satisfy
the buffer's record based writes. Thus, there may be
data fragments still being assembled that must be written
to the output stream before this entry is closed and the
next entry written.
throws:
IOException - on error |
| finish | | public void finish() throws IOException(Code) | | Ends the TAR archive without closing the underlying OutputStream.
The result is that the two EOF records of nulls are written.
throws:
IOException - on error |
| getRecordSize | | public int getRecordSize()(Code) | | Get the record size being used by this stream's TarBuffer.
The TarBuffer record size. |
| putNextEntry | | public void putNextEntry(TarEntry entry) throws IOException(Code) | | Put an entry on the output stream. This writes the entry's
header record and positions the output stream for writing
the contents of the entry. Once this method is called, the
stream is ready for calls to write() to write the entry's
contents. Once the contents are written, closeEntry()
MUST be called to ensure that all buffered data
is completely written to the output stream.
Parameters:
entry - The TarEntry to be written to the archive.
throws:
IOException - on error |
| setBufferDebug | | public void setBufferDebug(boolean debug)(Code) | | Sets the debugging flag in this stream's TarBuffer.
Parameters:
debug - True to turn on debugging. |
| setDebug | | public void setDebug(boolean debugF)(Code) | | Sets the debugging flag.
Parameters:
debugF - True to turn on debugging. |
| setLongFileMode | | public void setLongFileMode(int longFileMode)(Code) | | Set the long file mode.
This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2).
This specifies the treatment of long file names (names >= TarConstants.NAMELEN).
Default is LONGFILE_ERROR.
Parameters:
longFileMode - the mode to use |
| write | | public void write(int b) throws IOException(Code) | | Writes a byte to the current tar archive entry.
This method simply calls read( byte[], int, int ).
Parameters:
b - The byte written.
throws:
IOException - on error |
| write | | public void write(byte[] wBuf) throws IOException(Code) | | Writes bytes to the current tar archive entry.
This method simply calls write( byte[], int, int ).
Parameters:
wBuf - The buffer to write to the archive.
throws:
IOException - on error |
| write | | public void write(byte[] wBuf, int wOffset, int numToWrite) throws IOException(Code) | | Writes bytes to the current tar archive entry. This method
is aware of the current entry and will throw an exception if
you attempt to write bytes past the length specified for the
current entry. The method is also (painfully) aware of the
record buffering required by TarBuffer, and manages buffers
that are not a multiple of recordsize in length, including
assembling records from small buffers.
Parameters:
wBuf - The buffer to write to the archive.
Parameters:
wOffset - The offset in the buffer from which to get bytes.
Parameters:
numToWrite - The number of bytes to write.
throws:
IOException - on error |
|
|