| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.io.OutputStream
java.io.FilterOutputStream
org.apache.tools.tar.TarOutputStream
public class TarOutputStream
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().
| Field Summary | |
|---|---|
| protected  byte[] | assemBuf | 
| protected  int | assemLen | 
| static int | BIGNUMBER_ERRORFail if a big number (e.g. | 
| static int | BIGNUMBER_POSIXPOSIX/PAX extensions are used to store big numbers in the archive. | 
| static int | BIGNUMBER_STARstar/GNU tar/BSD tar extensions are used to store big number in the archive. | 
| protected  TarBuffer | buffer | 
| protected  long | currBytes | 
| protected  java.lang.String | currName | 
| protected  long | currSize | 
| protected  boolean | debug | 
| static int | LONGFILE_ERRORFail if a long file name is required in the archive. | 
| static int | LONGFILE_GNUGNU tar extensions are used to store long file names in the archive. | 
| static int | LONGFILE_POSIXPOSIX/PAX extensions are used to store long file names in the archive. | 
| static int | LONGFILE_TRUNCATELong paths will be truncated in the archive. | 
| protected  int | longFileMode | 
| protected  byte[] | oneBuf | 
| protected  byte[] | recordBuf | 
| Fields inherited from class java.io.FilterOutputStream | 
|---|
| out | 
| Constructor Summary | |
|---|---|
| TarOutputStream(java.io.OutputStream os)Constructor for TarInputStream. | |
| TarOutputStream(java.io.OutputStream os,
                int blockSize)Constructor for TarInputStream. | |
| TarOutputStream(java.io.OutputStream os,
                int blockSize,
                int recordSize)Constructor for TarInputStream. | |
| TarOutputStream(java.io.OutputStream os,
                int blockSize,
                int recordSize,
                java.lang.String encoding)Constructor for TarInputStream. | |
| TarOutputStream(java.io.OutputStream os,
                int blockSize,
                java.lang.String encoding)Constructor for TarInputStream. | |
| TarOutputStream(java.io.OutputStream os,
                java.lang.String encoding)Constructor for TarInputStream. | |
| Method Summary | |
|---|---|
|  void | close()Ends the TAR archive and closes the underlying OutputStream. | 
|  void | closeEntry()Close an entry. | 
|  void | finish()Ends the TAR archive without closing the underlying OutputStream. | 
|  int | getRecordSize()Get the record size being used by this stream's TarBuffer. | 
|  void | putNextEntry(TarEntry entry)Put an entry on the output stream. | 
|  void | setAddPaxHeadersForNonAsciiNames(boolean b)Whether to add a PAX extension header for non-ASCII file names. | 
|  void | setBigNumberMode(int bigNumberMode)Set the big number mode. | 
|  void | setBufferDebug(boolean debug)Sets the debugging flag in this stream's TarBuffer. | 
|  void | setDebug(boolean debugF)Sets the debugging flag. | 
|  void | setLongFileMode(int longFileMode)Set the long file mode. | 
|  void | write(byte[] wBuf)Writes bytes to the current tar archive entry. | 
|  void | write(byte[] wBuf,
      int wOffset,
      int numToWrite)Writes bytes to the current tar archive entry. | 
|  void | write(int b)Writes a byte to the current tar archive entry. | 
| Methods inherited from class java.io.FilterOutputStream | 
|---|
| flush | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final int LONGFILE_ERROR
public static final int LONGFILE_TRUNCATE
public static final int LONGFILE_GNU
public static final int LONGFILE_POSIX
public static final int BIGNUMBER_ERROR
public static final int BIGNUMBER_STAR
public static final int BIGNUMBER_POSIX
protected boolean debug
protected long currSize
protected java.lang.String currName
protected long currBytes
protected byte[] oneBuf
protected byte[] recordBuf
protected int assemLen
protected byte[] assemBuf
protected TarBuffer buffer
protected int longFileMode
| Constructor Detail | 
|---|
public TarOutputStream(java.io.OutputStream os)
os - the output stream to use
public TarOutputStream(java.io.OutputStream os,
                       java.lang.String encoding)
os - the output stream to useencoding - name of the encoding to use for file names
public TarOutputStream(java.io.OutputStream os,
                       int blockSize)
os - the output stream to useblockSize - the block size to use
public TarOutputStream(java.io.OutputStream os,
                       int blockSize,
                       java.lang.String encoding)
os - the output stream to useblockSize - the block size to useencoding - name of the encoding to use for file names
public TarOutputStream(java.io.OutputStream os,
                       int blockSize,
                       int recordSize)
os - the output stream to useblockSize - the block size to userecordSize - the record size to use
public TarOutputStream(java.io.OutputStream os,
                       int blockSize,
                       int recordSize,
                       java.lang.String encoding)
os - the output stream to useblockSize - the block size to userecordSize - the record size to useencoding - name of the encoding to use for file names| Method Detail | 
|---|
public void setLongFileMode(int longFileMode)
longFileMode - the mode to usepublic void setBigNumberMode(int bigNumberMode)
bigNumberMode - the mode to usepublic void setAddPaxHeadersForNonAsciiNames(boolean b)
public void setDebug(boolean debugF)
debugF - True to turn on debugging.public void setBufferDebug(boolean debug)
debug - True to turn on debugging.
public void finish()
            throws java.io.IOException
java.io.IOException - on error
public void close()
           throws java.io.IOException
close in interface java.io.Closeableclose in class java.io.FilterOutputStreamjava.io.IOException - on errorpublic int getRecordSize()
public void putNextEntry(TarEntry entry)
                  throws java.io.IOException
entry - The TarEntry to be written to the archive.
java.io.IOException - on error
public void closeEntry()
                throws java.io.IOException
java.io.IOException - on error
public void write(int b)
           throws java.io.IOException
write in class java.io.FilterOutputStreamb - The byte written.
java.io.IOException - on error
public void write(byte[] wBuf)
           throws java.io.IOException
write in class java.io.FilterOutputStreamwBuf - The buffer to write to the archive.
java.io.IOException - on error
public void write(byte[] wBuf,
                  int wOffset,
                  int numToWrite)
           throws java.io.IOException
write in class java.io.FilterOutputStreamwBuf - The buffer to write to the archive.wOffset - The offset in the buffer from which to get bytes.numToWrite - The number of bytes to write.
java.io.IOException - on error| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||