RawZipOutputStream (TrueZIP Driver ZIP 7.4.1 API)

java.lang.Object
- java.io.OutputStream
- - de.schlichtherle.truezip.io.DecoratingOutputStream
  - - de.schlichtherle.truezip.zip.RawZipOutputStream<E>

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Iterable<E>

Direct Known Subclasses:

ZipOutputShop, ZipOutputStream
```
@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class RawZipOutputStream<E extends ZipEntry>
extends DecoratingOutputStream
implements Iterable<E>
```
Provides unsafe (raw) access to a ZIP file using unsynchronized methods and shared ZipEntry instances.
Warning: This class is not intended for public use - its API may change at will without prior notification!

Author:

Christian Schlichtherle

See Also:
RawZipFile

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RawZipOutputStream.AppendingLEDataOutputStream` Adjusts the number of written bytes in the offset for appending mode.
`private class`	`RawZipOutputStream.BZip2OutputMethod`
`private class`	`RawZipOutputStream.Crc32CheckingOutputMethod`
`private class`	`RawZipOutputStream.Crc32OutputMethod`
`private class`	`RawZipOutputStream.Crc32UpdatingOutputMethod`
`private class`	`RawZipOutputStream.DeflaterOutputMethod`
`private class`	`RawZipOutputStream.EncryptedOutputMethod`
`private class`	`RawZipOutputStream.RawOutputMethod`
`private class`	`RawZipOutputStream.WinZipAesOutputMethod`

Field Summary

Fields
Modifier and Type	Field and Description
`private long`	`cdOffset` Start of central directory.
`private Charset`	`charset` The charset to use for entry names and comments.
`private boolean`	`closed`
`private byte[]`	`comment` The encoded file comment.
`private LEDataOutputStream`	`dos`
`private Map<String,E>`	`entries` The list of ZIP entries started to be written so far.
`private ZipEntry`	`entry` Current ZIP entry.
`private boolean`	`finished`
`private int`	`level` Default compression level for the methods DEFLATED and BZIP2.
`private int`	`method` Default compression method for next entry.
`private OutputMethod`	`processor`

Fields inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream
delegate

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RawZipOutputStream(OutputStream out, RawZipFile<E> appendee, ZipOutputStreamParameters param)` Constructs a raw ZIP output stream which decorates the given output stream and optionally apppends to the given raw ZIP file.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this output stream and releases any system resources associated with the stream.
`void`	`closeEntry()` Writes all necessary data for this entry to the underlying stream.
`private String`	`decode(byte[] bytes)`
`private byte[]`	`encode(String string)`
`void`	`finish()` Closes the current entry and writes the Central Directory to the underlying output stream.
`private int`	`getBZip2BlockSize()`
`String`	`getCharset()` Returns the name of the character set which is used for encoding entry names and the file comment.
`String`	`getComment()` Returns the file comment.
`private byte[]`	`getCommentEncoded(ZipEntry entry)`
`protected abstract ZipCryptoParameters`	`getCryptoParameters()` Returns the parameters for encryption or authentication of entries.
`E`	`getEntry(String name)` Returns the entry for the given name or `null` if no entry with this name exists.
`int`	`getLevel()` Returns the compression level for entries.
`int`	`getMethod()` Returns the default compression method for subsequent entries.
`Charset`	`getRawCharset()` Returns the character set which is used for encoding entry names and the file comment.
`private byte[]`	`getRawComment()`
`boolean`	`isBusy()` Returns `true` if and only if this `RawZipOutputStream` is currently writing a ZIP entry.
`Iterator<E>`	`iterator()` Returns an iteration of all entries written to this ZIP file so far.
`long`	`length()` Returns the total number of (compressed) bytes this stream has written to the underlying stream.
`private RawZipOutputStream.EncryptedOutputMethod`	`newEncryptedOutputMethod(RawZipOutputStream.RawOutputMethod processor, ZipParameters param)` Returns a new `EncryptedOutputMethod`.
`private static LEDataOutputStream`	`newLEDataOutputStream(OutputStream out, RawZipFile<?> appendee)`
`private OutputMethod`	`newOutputMethod(ZipEntry entry, boolean process)` Returns a new output method for the given entry.
`void`	`putNextEntry(E entry)` Equivalent to `putNextEntry(entry, true)`.
`void`	`putNextEntry(E entry, boolean process)` Starts writing the next ZIP entry to the underlying stream.
`void`	`setComment(String comment)` Sets the file comment.
`void`	`setLevel(int level)` Sets the compression level for entries.
`private void`	`setLevel0(int level)`
`void`	`setMethod(int method)` Sets the default compression method for entries.
`private void`	`setMethod0(int method)`
`int`	`size()` Returns the number of ZIP entries written so far.
`private boolean`	`writeCentralFileHeader(ZipEntry entry)` Writes a Central File Header record.
`private void`	`writeEndOfCentralDirectory()` Writes the End Of Central Directory record.

Methods inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream
flush, toString, write, write, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cdOffset
```
private long cdOffset
```
    Start of central directory.
  - charset
```
private final Charset charset
```
    The charset to use for entry names and comments.
  - closed
```
private boolean closed
```
  - comment
```
@CheckForNull
private byte[] comment
```
    The encoded file comment.
  - dos
```
private final LEDataOutputStream dos
```
  - entries
```
private final Map<String,E extends ZipEntry> entries
```
    The list of ZIP entries started to be written so far. Maps entry names to zip entries.
  - entry
```
@Nullable
private ZipEntry entry
```
    Current ZIP entry.
  - finished
```
private boolean finished
```
  - level
```
private int level
```
    Default compression level for the methods DEFLATED and BZIP2.
  - method
```
private int method
```
    Default compression method for next entry.
  - processor
```
@Nullable
private OutputMethod processor
```
- Constructor Detail
  - RawZipOutputStream
```
protected RawZipOutputStream(OutputStream out,
                  @CheckForNull
                  RawZipFile<E> appendee,
                  ZipOutputStreamParameters param)
```
    Constructs a raw ZIP output stream which decorates the given output stream and optionally apppends to the given raw ZIP file.
    
    Parameters:
    out - The output stream to write the ZIP file to. If appendee is not null, then this must be set up so that it appends to the same ZIP file from which appendee is reading.
    appendee - the nullable raw ZIP file to append to. This may already be closed.
    param - the parameters for writing the ZIP file.
    Since:
    
    TrueZIP 7.3
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Closes this output stream and releases any system resources associated with the stream. This closes the open output stream writing to this ZIP file, if any.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class DecoratingOutputStream
    
    Throws:
    
    IOException - On any I/O error.
  - closeEntry
```
public void closeEntry()
                throws IOException
```
    Writes all necessary data for this entry to the underlying stream.
    
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - decode
```
private String decode(byte[] bytes)
```
  - encode
```
private byte[] encode(String string)
```
  - finish
```
public void finish()
            throws IOException
```
    Closes the current entry and writes the Central Directory to the underlying output stream.
    Notes:
    - The underlying stream is not closed.
    - Unlike Sun's implementation in J2SE 1.4.2, you may continue to use this ZIP output stream with putNextEntry(...) and the like. When you finally close the stream, the central directory will contain all entries written.
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - getBZip2BlockSize
```
private int getBZip2BlockSize()
```
  - getCharset
```
public String getCharset()
```
    Returns the name of the character set which is used for encoding entry names and the file comment.
  - getComment
```
@Nullable
public String getComment()
```
    Returns the file comment.
    
    Returns:
    The file comment.
  - getCommentEncoded
```
private byte[] getCommentEncoded(ZipEntry entry)
```
  - getCryptoParameters
```
@CheckForNull
protected abstract ZipCryptoParameters getCryptoParameters()
```
    Returns the parameters for encryption or authentication of entries. Returns The parameters for encryption or authentication of entries.
    
    Since:
    
    TrueZIP 7.3
  - getEntry
```
public E getEntry(String name)
```
    Returns the entry for the given name or null if no entry with this name exists. Note that the returned entry is shared with this instance. It is illegal to change its state!
    
    Parameters:
    name - the name of the ZIP entry.
  - getLevel
```
public int getLevel()
```
    Returns the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2.
    
    Returns:
    The compression level for entries.
    See Also:
    setLevel(int)
  - getMethod
```
public int getMethod()
```
    Returns the default compression method for subsequent entries. This property is only used if a ZipEntry does not specify a compression method. The initial value is ZipEntry.DEFLATED.
    
    See Also:
    setMethod(int), ZipEntry.getMethod()
  - getRawCharset
```
public Charset getRawCharset()
```
    Returns the character set which is used for encoding entry names and the file comment.
    
    Since:
    
    TrueZIP 7.3
  - getRawComment
```
private byte[] getRawComment()
```
  - isBusy
```
public boolean isBusy()
```
    Returns true if and only if this RawZipOutputStream is currently writing a ZIP entry.
  - iterator
```
public Iterator<E> iterator()
```
    Returns an iteration of all entries written to this ZIP file so far. Note that the iteration supports element removal and the returned entries are shared with this instance. It is illegal to put more entries into this ZIP output stream concurrently or modify the state of the iterated entries.
    
    Specified by:
    
    iterator in interface Iterable<E extends ZipEntry>
  - length
```
public long length()
```
    Returns the total number of (compressed) bytes this stream has written to the underlying stream.
  - newEncryptedOutputMethod
```
private RawZipOutputStream.EncryptedOutputMethod newEncryptedOutputMethod(RawZipOutputStream.RawOutputMethod processor,
                                                                @CheckForNull
                                                                ZipParameters param)
                                                                   throws ZipParametersException
```
    Returns a new EncryptedOutputMethod.
    
    Parameters:
    processor - the output method to decorate.
    param - the ZipCryptoParameters used to determine and configure the type of the encrypted ZIP file. If the run time class of this parameter matches multiple parameter interfaces, it is at the discretion of this implementation which one is picked and hence which type of encrypted ZIP file is created. If you need more control over this, pass in an instance which's run time class just implements the ZipParametersProvider interface. Instances of this interface are queried to find crypto parameters which match a known encrypted ZIP file type. This algorithm is recursively applied.
    
    Returns:
    A new EncryptedOutputMethod.
    
    Throws:
    
    ZipCryptoParametersException - if param is null or no suitable crypto parameters can get found.
    
    ZipParametersException
  - newLEDataOutputStream
```
private static LEDataOutputStream newLEDataOutputStream(OutputStream out,
                                       @CheckForNull
                                       RawZipFile<?> appendee)
```
  - newOutputMethod
```
private OutputMethod newOutputMethod(ZipEntry entry,
                           boolean process)
                              throws ZipException
```
    Returns a new output method for the given entry. Except the property "method", this method must not modify the given entry.
    
    Throws:
    
    ZipException
  - putNextEntry
```
public final void putNextEntry(E entry)
                        throws IOException
```
    Equivalent to putNextEntry(entry, true).
    
    Throws:
    
    IOException
  - putNextEntry
```
public void putNextEntry(E entry,
                boolean process)
                  throws IOException
```
    Starts writing the next ZIP entry to the underlying stream. Note that if two or more entries with the same name are written consecutively to this stream, the last entry written will shadow all other entries, i.e. all of them are written to the ZIP file (and hence require space), but only the last will be listed in the central directory. This is unlike the genuine java.util.zip.ZipOutputStream which would throw a ZipException in this method when another entry with the same name is to be written.
    
    Parameters:
    entry - The entry to write.
    process - Whether or not the entry contents should get processed, e.g. deflated. This should be set to false if and only if the application is going to copy entries from an input ZIP file to an output ZIP file. The entries' CRC-32, compressed size and uncompressed size properties must be set in advance.
    
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - setComment
```
public void setComment(@CheckForNull
              String comment)
```
    Sets the file comment.
    
    Parameters:
    comment - the file comment.
    
    Throws:
    
    IllegalArgumentException - if the encoded comment is longer than UShort.MAX_VALUE bytes.
  - setLevel
```
public void setLevel(int level)
```
    Sets the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2. Legal values are Deflater.DEFAULT_COMPRESSION or range from Deflater#BEST_SPEED to Deflater#BEST_COMPRESSION.
    
    Parameters:
    level - the compression level for entries.
    
    Throws:
    
    IllegalArgumentException - if the compression level is invalid.
    See Also:
    getLevel()
  - setLevel0
```
private void setLevel0(int level)
```
  - setMethod
```
public void setMethod(int method)
```
    Sets the default compression method for entries. This property is only used if a ZipEntry does not specify a compression method. Legal values are ZipEntry.STORED, ZipEntry.DEFLATED and ZipEntry.BZIP2.
    
    Parameters:
    method - the default compression method for entries.
    
    Throws:
    
    IllegalArgumentException - if the method is invalid.
    See Also:
    getMethod(), ZipEntry.setMethod(int)
  - setMethod0
```
private void setMethod0(int method)
```
  - size
```
public int size()
```
    Returns the number of ZIP entries written so far.
  - writeCentralFileHeader
```
private boolean writeCentralFileHeader(ZipEntry entry)
                                throws IOException
```
    Writes a Central File Header record.
    
    Returns:
    false if and only if the record has been skipped, i.e. not written for some other reason than an I/O error.
    
    Throws:
    
    IOException - On any I/O error.
  - writeEndOfCentralDirectory
```
private void writeEndOfCentralDirectory()
                                 throws IOException
```
    Writes the End Of Central Directory record.
    
    Throws:
    
    IOException - On any I/O error.

Class RawZipOutputStream<E extends ZipEntry>

Nested Class Summary

Field Summary

Fields inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream

Methods inherited from class java.lang.Object

Field Detail

cdOffset

charset

closed

comment

dos

entries

entry

finished

level

method

processor

Constructor Detail

RawZipOutputStream

Method Detail

close

closeEntry

decode

encode

finish

getBZip2BlockSize

getCharset

getComment

getCommentEncoded

getCryptoParameters

getEntry

getLevel

getMethod

getRawCharset

getRawComment

isBusy

iterator

length

newEncryptedOutputMethod

newLEDataOutputStream

newOutputMethod

putNextEntry

putNextEntry

setComment

setLevel

setLevel0

setMethod

setMethod0

size

writeCentralFileHeader

writeEndOfCentralDirectory