Apache Ant Core 1.10.14 · org.apache.tools.zip.ZipOutputStream

Modifier and Type	Class and Description
private static class	ZipOutputStream.CurrentEntry Structure collecting information for the entry that is currently being written.
public static class	ZipOutputStream.UnicodeExtraFieldPolicy enum that represents the possible policies for creating Unicode extra fields.

Field Summary

Modifier and Type	Field and Description
protected byte[]	buf This buffer serves as a Deflater.
private static final int	BUFFER_SIZE
private final Calendar	calendarInstance
private long	cdLength Length of central directory.
private long	cdOffset Start of central directory.
private static final int	CFH_COMMENT_LENGTH_OFFSET
private static final int	CFH_COMPRESSED_SIZE_OFFSET
private static final int	CFH_CRC_OFFSET
private static final int	CFH_DISK_NUMBER_OFFSET
private static final int	CFH_EXTERNAL_ATTRIBUTES_OFFSET
private static final int	CFH_EXTRA_LENGTH_OFFSET
private static final int	CFH_FILENAME_LENGTH_OFFSET
private static final int	CFH_FILENAME_OFFSET
private static final int	CFH_GPB_OFFSET
private static final int	CFH_INTERNAL_ATTRIBUTES_OFFSET
private static final int	CFH_LFH_OFFSET
private static final int	CFH_METHOD_OFFSET
private static final int	CFH_ORIGINAL_SIZE_OFFSET
protected static final byte[]	CFH_SIG central file header signature
private static final int	CFH_SIG_OFFSET
private static final int	CFH_TIME_OFFSET
private static final int	CFH_VERSION_MADE_BY_OFFSET
private static final int	CFH_VERSION_NEEDED_OFFSET
private String	comment The file comment.
private final CRC32	crc CRC instance to avoid parsing DEFLATED data twice.
private ZipOutputStream.UnicodeExtraFieldPolicy	createUnicodeExtraFields whether to create UnicodePathExtraField-s for each entry.
protected static final byte[]	DD_SIG data descriptor signature
protected final Deflater	def This Deflater object is used for output.
public static final int	DEFAULT_COMPRESSION Default compression level for deflated entries.
pack-priv static final String	DEFAULT_ENCODING default encoding for file names and comment.
public static final int	DEFLATED Compression method for deflated entries.
private static final int	DEFLATER_BLOCK_SIZE
public static final int	EFS_FLAG General purpose flag, which indicates that filenames are written in utf-8.
private static final byte[]	EMPTY
private String	encoding The encoding to use for filenames and the file comment.
private final List<ZipEntry>	entries List of ZipEntries written so far.
private ZipOutputStream.CurrentEntry	entry Current entry.
protected static final byte[]	EOCD_SIG end of central dir signature
private boolean	fallbackToUTF8 Whether to encode non-encodable file names as UTF-8.
private boolean	finished indicates if this archive is finished.
private boolean	hasCompressionLevelChanged Has the compression level changed when compared to the last entry?
private boolean	hasUsedZip64 Whether anything inside this archive has used a ZIP64 feature.
private int	level Compression level for next entry.
private static final int	LFH_COMPRESSED_SIZE_OFFSET
private static final int	LFH_CRC_OFFSET
private static final int	LFH_EXTRA_LENGTH_OFFSET
private static final int	LFH_FILENAME_LENGTH_OFFSET
private static final int	LFH_FILENAME_OFFSET
private static final int	LFH_GPB_OFFSET
private static final int	LFH_METHOD_OFFSET
private static final int	LFH_ORIGINAL_SIZE_OFFSET
protected static final byte[]	LFH_SIG local file header signature
private static final int	LFH_SIG_OFFSET
private static final int	LFH_TIME_OFFSET
private static final int	LFH_VERSION_NEEDED_OFFSET
private static final byte[]	LZERO Helper, a 0 as ZipLong.
private int	method Default compression method for next entry.
private final Map<ZipEntry, Long>	offsets Holds the offsets of the LFH starts for each entry.
private static final byte[]	ONE
private final byte[]	oneByte Temporary buffer used for the `write(int)` method.
private final RandomAccessFile	raf Optional random access output.
public static final int	STORED Compression method for stored entries.
private boolean	useUTF8Flag whether to use the general purpose bit flag when writing UTF-8 filenames or not.
private long	written Count the bytes written to out.
private static final byte[]	ZERO Helper, a 0 as ZipShort.
pack-priv static final byte[]	ZIP64_EOCD_LOC_SIG ZIP64 end of central dir locator signature
pack-priv static final byte[]	ZIP64_EOCD_SIG ZIP64 end of central dir signature
private Zip64Mode	zip64Mode
private ZipEncoding	zipEncoding The zip encoding to use for filenames and the file comment.

Inherited from java.io.FilterOutputStream:: out

Access	Constructor and Description
public	ZipOutputStream(OutputStream the outputstream to zip out) Creates a new ZIP OutputStream filtering the underlying stream.
public	ZipOutputStream(File the file to zip to file) Creates a new ZIP OutputStream writing to a File.

Method Summary

Modifier and Type	Method and Description
private void	addUnicodeExtraFields(ZipEntry ZipEntry ze, boolean boolean encodable, ByteBuffer ByteBuffer name) Adds UnicodeExtra fields for name and file comment if mode is ALWAYS or the data cannot be encoded using the configured encoding.
protected static long	Returns: the unsigned int as a long. adjustToLong(int the value to treat as unsigned int. i) Deprecated use ZipUtil#adjustToLong Assumes a negative integer really is a positive integer that has wrapped around and re-creates the original value.
public boolean	Returns: boolean canWriteEntryData(ZipEntry ZipEntry ae) Whether this stream is able to write the given entry.
private boolean	Returns: boolean checkIfNeedsZip64(Zip64Mode Zip64Mode effectiveMode) Ensures the current entry's size and CRC information is set to the values just written, verifies it isn't too big in the Zip64Mode.Never case and returns whether the entry would require a Zip64 extra field.
public void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with the stream.
public void	closeEntry() Writes all necessary data for this entry.
private void	closeEntry(boolean actuallyNeedsZip64)
private byte[]	createCentralFileHeader(ZipEntry ze)
private byte[]	createCentralFileHeader(ZipEntry the entry to write ze, ByteBuffer The encoded name name, long Local file header offset for this file lfhOffset, boolean needsZip64Extra) Writes the central file header entry.
private byte[]	createLocalFileHeader(ZipEntry ze, ByteBuffer name, boolean encodable)
protected final void	deflate() Writes next block of compressed data to the output stream.
private void	deflateUntilInputIsNeeded()
pack-priv void	destroy() Closes the underlying stream/file without finishing the archive, the result will likely be a corrupt archive.
public void	finish() Finish writing the archive.
public void	flush() Overrides java.io.FilterOutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out to the stream.
private void	flushDeflater() Ensures all bytes sent to the deflater are written to the stream.
protected byte[]	Returns: the bytes as a byte array getBytes(String the string to get bytes from name) Retrieve the bytes for the given String in the encoding set for this Stream.
private Zip64Mode	Returns: Zip64Mode getEffectiveZip64Mode(ZipEntry ZipEntry ze) If the mode is AsNeeded and the entry is a compressed entry of unknown size that gets written to a non-seekable stream the change the default to Never.
public String	Returns: null if using the platform's default character encoding. getEncoding() The encoding to use for filenames and the file comment.
private ZipEncoding	getEntryEncoding(ZipEntry ze)
private GeneralPurposeBit	getGeneralPurposeBits(final int zipMethod, final boolean utfFallback)
private ByteBuffer	getName(ZipEntry ze)
private Zip64ExtendedInformationExtraField	Returns: Zip64ExtendedInformationExtraField getZip64Extra(ZipEntry ZipEntry ze) Get the existing ZIP64 extended information extra field or create a new one and add it to the entry.
private boolean	Returns: boolean handleSizesAndCrc(long long bytesWritten, long long crc, Zip64Mode Zip64Mode effectiveMode) Ensures the current entry's size and CRC information is set to the values just written, verifies it isn't too big in the Zip64Mode.Never case and returns whether the entry would require a Zip64 extra field.
private void	handleZip64Extra(ZipEntry ZipEntry ze, long long lfhOffset, boolean boolean needsZip64Extra) If the entry needs Zip64 extra information inside the central directory then configure its data.
private boolean	Returns: boolean hasZip64Extra(ZipEntry ZipEntry ze) Is there a ZIP64 extended information extra field for the entry?
private boolean	isDeflatedToOutputStream(int zipMethod)
public boolean	Returns: true if seekable isSeekable() This method indicates whether this archive is writing to a seekable stream (i.e., to a random access file).
private boolean	isTooLageForZip32(ZipEntry zipArchiveEntry)
private boolean	isZip64Required(ZipEntry entry1, Zip64Mode requestedMode)
private void	preClose()
public void	putNextEntry(ZipEntry archiveEntry) Put the specified entry into the archive.
private void	rewriteSizesAndCrc(boolean boolean actuallyNeedsZip64) When using random access output, write the local file header and potentially the ZIP64 extra containing the correct CRC and compressed/uncompressed sizes.
public void	setComment(String the comment comment) Set the file comment.
public void	setCreateUnicodeExtraFields(ZipOutputStream.UnicodeExtraFieldPolicy boolean b) Whether to create Unicode Extra Fields.
private void	setDefaults(ZipEntry ZipEntry entry) Provides default values for compression method and last modification time.
public void	setEncoding(final String the encoding value encoding) The encoding to use for filenames and the file comment.
public void	setFallbackToUTF8(boolean boolean b) Whether to fall back to UTF and the language encoding flag if the file name cannot be encoded using the specified encoding.
public void	setLevel(int the compression level. level) Sets the compression level for subsequent entries.
public void	setMethod(int an `int` from java.util.zip.ZipEntry method) Sets the default compression method for subsequent entries.
public void	setUseLanguageEncodingFlag(boolean boolean b) Whether to set the language encoding flag if the file name encoding is UTF-8.
public void	setUseZip64(Zip64Mode Zip64Mode mode) Whether Zip64 extensions will be used.
private boolean	shouldAddZip64Extra(ZipEntry ZipEntry entry, Zip64Mode Zip64Mode mode) Whether to add a Zip64 extended information extra field to the local file header.
protected static ZipLong	Returns: the date as a `ZipLong` toDosTime(Date the `Date` to convert time) Deprecated use ZipUtil#toDosTime Convert a Date object to a DOS date/time field.
protected static byte[]	Returns: the date as a byte array toDosTime(long number of milliseconds since the epoch t) Deprecated use ZipUtil#toDosTime Convert a Date object to a DOS date/time field.
private void	validateSizeInformation(Zip64Mode Zip64Mode effectiveMode) Throws an exception if the size is unknown for a stored entry that is written to a non-seekable output or the entry is too big to be written without Zip64 extra but the mode has been set to Never.
private int	versionNeededToExtract(final int zipMethod, final boolean zip64)
public void	write(int the byte to write b) Overrides java.io.FilterOutputStream.write. Writes a byte to ZIP entry.
public void	write(byte[] the byte array to write b, int the start position to write from offset, int the number of bytes to write length) Overrides java.io.FilterOutputStream.write. Writes bytes to ZIP entry.
protected void	writeCentralDirectoryEnd() Writes the "End of central dir record".
private void	writeCentralDirectoryInChunks()
protected void	writeCentralFileHeader(ZipEntry the entry to write ze) Writes the central file header entry.
private void	writeCounted(byte[] the byte array to write data) Write bytes to output or random access file.
private void	writeCounted(byte[] data, int offset, int length)
protected void	writeDataDescriptor(ZipEntry the entry to write ze) Writes the data descriptor entry.
private void	writeDeflated(byte[] byte[] b, int int offset, int int length) write implementation for DEFLATED entries.
protected void	writeLocalFileHeader(ZipEntry the entry to write ze) Writes the local file header entry
protected final void	writeOut(byte[] the byte array to write data) Write bytes to output or random access file.
protected final void	writeOut(byte[] the byte array to write data, int the start position to write from offset, int the number of bytes to write length) Write bytes to output or random access file.
protected void	writeZip64CentralDirectory() Writes the "ZIP64 End of central dir record" and "ZIP64 End of central dir locator".

Inherited from java.io.FilterOutputStream:: write

public Class ZipOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary