org.apache.commons.compress.archivers.ar
Class ArArchiveOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by org.apache.commons.compress.archivers.ArchiveOutputStream
          extended by org.apache.commons.compress.archivers.ar.ArArchiveOutputStream
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable

public class ArArchiveOutputStream
extends ArchiveOutputStream

Implements the "ar" archive format as an output stream.


Constructor Summary
ArArchiveOutputStream(java.io.OutputStream pOut)
           
 
Method Summary
 void close()
           
 void closeArchiveEntry()
          Closes the archive entry, writing any trailer information that may be required.
 ArchiveEntry createArchiveEntry(java.io.File inputFile, java.lang.String entryName)
          Create an archive entry using the inputFile and entryName provided.
 void finish()
          Finishes the addition of entries to this stream, without closing it.
 void putArchiveEntry(ArchiveEntry pEntry)
          Writes the headers for an archive entry to the output stream.
 void write(byte[] b, int off, int len)
           
 
Methods inherited from class org.apache.commons.compress.archivers.ArchiveOutputStream
count, getCount, write
 
Methods inherited from class java.io.OutputStream
flush, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArArchiveOutputStream

public ArArchiveOutputStream(java.io.OutputStream pOut)
Method Detail

closeArchiveEntry

public void closeArchiveEntry()
                       throws java.io.IOException
Description copied from class: ArchiveOutputStream
Closes the archive entry, writing any trailer information that may be required.

Specified by:
closeArchiveEntry in class ArchiveOutputStream
Throws:
java.io.IOException

putArchiveEntry

public void putArchiveEntry(ArchiveEntry pEntry)
                     throws java.io.IOException
Description copied from class: ArchiveOutputStream
Writes the headers for an archive entry to the output stream. The caller must then write the content to the stream and call ArchiveOutputStream.closeArchiveEntry() to complete the process.

Specified by:
putArchiveEntry in class ArchiveOutputStream
Parameters:
pEntry - describes the entry
Throws:
java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
Overrides:
write in class java.io.OutputStream
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Specified by:
close in interface java.io.Closeable
Overrides:
close in class java.io.OutputStream
Throws:
java.io.IOException

createArchiveEntry

public ArchiveEntry createArchiveEntry(java.io.File inputFile,
                                       java.lang.String entryName)
                                throws java.io.IOException
Description copied from class: ArchiveOutputStream
Create an archive entry using the inputFile and entryName provided.

Specified by:
createArchiveEntry in class ArchiveOutputStream
Returns:
the ArchiveEntry set up with details from the file
Throws:
java.io.IOException

finish

public void finish()
            throws java.io.IOException
Description copied from class: ArchiveOutputStream
Finishes the addition of entries to this stream, without closing it. Additional data can be written, if the format supports it. The finish() method throws an Exception if the user forgets to close the entry .

Specified by:
finish in class ArchiveOutputStream
Throws:
java.io.IOException


Copyright © 2001-2011 Apache Software Foundation. All Rights Reserved.