Apache Commons Compress 1.26.0 · org.apache.commons.compress.archivers.zip.Zip64ExtendedInformationExtraField

Field Summary

Modifier and Type	Field and Description
private ZipEightByteInteger	compressedSize
private ZipLong	diskStart
pack-priv static final ZipShort	HEADER_ID
private static final String	LFH_MUST_HAVE_BOTH_SIZES_MSG
private byte[]	rawCentralDirectoryData Stored in `parseFromCentralDirectoryData` so it can be reused when ZipFile calls `reparseCentralDirectoryData`.
private ZipEightByteInteger	relativeHeaderOffset
private ZipEightByteInteger	size

Constructor Summary

Access	Constructor and Description
public	Zip64ExtendedInformationExtraField() This constructor should only be used by the code that reads archives inside of Commons Compress.
public	Zip64ExtendedInformationExtraField(final ZipEightByteInteger the entry's original size size, final ZipEightByteInteger the entry's compressed size compressedSize) Creates an extra field based on the original and compressed size.
public	Zip64ExtendedInformationExtraField(final ZipEightByteInteger the entry's original size size, final ZipEightByteInteger the entry's compressed size compressedSize, final ZipEightByteInteger the entry's offset relativeHeaderOffset, final ZipLong the disk start diskStart) Creates an extra field based on all four possible values.

Method Summary

Modifier and Type	Method and Description
private int	addSizes(final byte[] data)
public byte[]	getCentralDirectoryData() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryData. The actual data to put into central directory - without Header-ID or length specifier.
public ZipShort	getCentralDirectoryLength() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryLength. Length of the extra field in the central directory - without Header-ID or length specifier.
public ZipEightByteInteger	Returns: The compressed size stored in this extra field. getCompressedSize() The compressed size stored in this extra field.
public ZipLong	Returns: The disk start number stored in this extra field. getDiskStartNumber() The disk start number stored in this extra field.
public ZipShort	getHeaderId() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getHeaderId. The Header-ID.
public byte[]	getLocalFileDataData() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataData. The actual data to put into local file data - without Header-ID or length specifier.
public ZipShort	getLocalFileDataLength() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataLength. Length of the extra field in the local file data - without Header-ID or length specifier.
public ZipEightByteInteger	Returns: The relative header offset stored in this extra field. getRelativeHeaderOffset() The relative header offset stored in this extra field.
public ZipEightByteInteger	Returns: The uncompressed size stored in this extra field. getSize() The uncompressed size stored in this extra field.
public void	parseFromCentralDirectoryData(final byte[] the buffer to read data from buffer, int offset into buffer to read data offset, final int the length of data length) Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromCentralDirectoryData. Populate data from this array as if it was in central directory data.
public void	parseFromLocalFileData(final byte[] the buffer to read data from buffer, int offset into buffer to read data offset, final int the length of data length) Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromLocalFileData. Populate data from this array as if it was in local file data.
public void	reparseCentralDirectoryData(final boolean flag to read from central directory hasUncompressedSize, final boolean flag to read from central directory hasCompressedSize, final boolean flag to read from central directory hasRelativeHeaderOffset, final boolean flag to read from central directory hasDiskStart) Parses the raw bytes read from the central directory extra field with knowledge which fields are expected to be there.
public void	setCompressedSize(final ZipEightByteInteger The uncompressed size stored in this extra field. compressedSize) The uncompressed size stored in this extra field.
public void	setDiskStartNumber(final ZipLong The disk start number stored in this extra field. ds) The disk start number stored in this extra field.
public void	setRelativeHeaderOffset(final ZipEightByteInteger The relative header offset stored in this extra field. rho) The relative header offset stored in this extra field.
public void	setSize(final ZipEightByteInteger The uncompressed size stored in this extra field. size) The uncompressed size stored in this extra field.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

compressedSize	back to summary
private ZipEightByteInteger compressedSize

diskStart	back to summary
private ZipLong diskStart

HEADER_ID	back to summary
pack-priv static final ZipShort HEADER_ID

LFH_MUST_HAVE_BOTH_SIZES_MSG	back to summary
private static final String LFH_MUST_HAVE_BOTH_SIZES_MSG

rawCentralDirectoryData back to summary

rawCentralDirectoryData	back to summary
private byte[] rawCentralDirectoryData Stored in `parseFromCentralDirectoryData` so it can be reused when ZipFile calls `reparseCentralDirectoryData`. Not used for anything else Since 1.3

private byte[] rawCentralDirectoryData

Stored in parseFromCentralDirectoryData so it can be reused when ZipFile calls reparseCentralDirectoryData.

Not used for anything else

Since: 1.3

relativeHeaderOffset	back to summary
private ZipEightByteInteger relativeHeaderOffset

size	back to summary
private ZipEightByteInteger size

Constructor Detail

Zip64ExtendedInformationExtraField	back to summary
public Zip64ExtendedInformationExtraField() This constructor should only be used by the code that reads archives inside of Commons Compress.

Zip64ExtendedInformationExtraField	back to summary
public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize) Creates an extra field based on the original and compressed size. Parameters size:ZipEightByteInteger the entry's original size compressedSize:ZipEightByteInteger the entry's compressed size Exceptions IllegalArgumentException: if size or compressedSize is null

Zip64ExtendedInformationExtraField

back to summary

public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize)

Creates an extra field based on the original and compressed size.

Parameters

size:ZipEightByteInteger: the entry's original size
compressedSize:ZipEightByteInteger: the entry's compressed size

Exceptions

IllegalArgumentException:: if size or compressedSize is null

Zip64ExtendedInformationExtraField	back to summary
public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize, final ZipEightByteInteger relativeHeaderOffset, final ZipLong diskStart) Creates an extra field based on all four possible values. Parameters size:ZipEightByteInteger the entry's original size compressedSize:ZipEightByteInteger the entry's compressed size relativeHeaderOffset:ZipEightByteInteger the entry's offset diskStart:ZipLong the disk start Exceptions IllegalArgumentException: if size or compressedSize is null

Zip64ExtendedInformationExtraField

back to summary

public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize, final ZipEightByteInteger relativeHeaderOffset, final ZipLong diskStart)

Creates an extra field based on all four possible values.

Parameters

size:ZipEightByteInteger: the entry's original size
compressedSize:ZipEightByteInteger: the entry's compressed size
relativeHeaderOffset:ZipEightByteInteger: the entry's offset
diskStart:ZipLong: the disk start

Exceptions

IllegalArgumentException:: if size or compressedSize is null

Method Detail

addSizes	back to summary
private int addSizes(final byte[] data)

getCentralDirectoryData	back to summary
public byte[] getCentralDirectoryData() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryData. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryData. The actual data to put into central directory - without Header-ID or length specifier. Returns:byte[] the data Annotations @Override

getCentralDirectoryData

back to summary

public byte[] getCentralDirectoryData()

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryData.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryData.

The actual data to put into central directory - without Header-ID or length specifier.

Returns:byte[]

the data

Annotations

@Override

getCentralDirectoryLength	back to summary
public ZipShort getCentralDirectoryLength() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryLength. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryLength. Length of the extra field in the central directory - without Header-ID or length specifier. Returns:ZipShort the length of the field in the central directory Annotations @Override

getCentralDirectoryLength

back to summary

public ZipShort getCentralDirectoryLength()

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryLength.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getCentralDirectoryLength.

Length of the extra field in the central directory - without Header-ID or length specifier.

Returns:ZipShort

the length of the field in the central directory

Annotations

@Override

getCompressedSize	back to summary
public ZipEightByteInteger getCompressedSize() The compressed size stored in this extra field. Returns:ZipEightByteInteger The compressed size stored in this extra field.

getCompressedSize

back to summary

public ZipEightByteInteger getCompressedSize()

The compressed size stored in this extra field.

Returns:ZipEightByteInteger: The compressed size stored in this extra field.

getDiskStartNumber	back to summary
public ZipLong getDiskStartNumber() The disk start number stored in this extra field. Returns:ZipLong The disk start number stored in this extra field.

getDiskStartNumber

back to summary

public ZipLong getDiskStartNumber()

The disk start number stored in this extra field.

Returns:ZipLong: The disk start number stored in this extra field.

getHeaderId	back to summary
public ZipShort getHeaderId() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getHeaderId. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getHeaderId. The Header-ID. Returns:ZipShort The HeaderId value Annotations @Override

getHeaderId

back to summary

public ZipShort getHeaderId()

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getHeaderId.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getHeaderId.

The Header-ID.

Returns:ZipShort

The HeaderId value

Annotations

@Override

getLocalFileDataData	back to summary
public byte[] getLocalFileDataData() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataData. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataData. The actual data to put into local file data - without Header-ID or length specifier. Returns:byte[] the data Annotations @Override

getLocalFileDataData

back to summary

public byte[] getLocalFileDataData()

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataData.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataData.

The actual data to put into local file data - without Header-ID or length specifier.

Returns:byte[]

the data

Annotations

@Override

getLocalFileDataLength	back to summary
public ZipShort getLocalFileDataLength() Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataLength. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataLength. Length of the extra field in the local file data - without Header-ID or length specifier. Returns:ZipShort the length of the field in the local file data Annotations @Override

getLocalFileDataLength

back to summary

public ZipShort getLocalFileDataLength()

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataLength.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.getLocalFileDataLength.

Length of the extra field in the local file data - without Header-ID or length specifier.

Returns:ZipShort

the length of the field in the local file data

Annotations

@Override

getRelativeHeaderOffset	back to summary
public ZipEightByteInteger getRelativeHeaderOffset() The relative header offset stored in this extra field. Returns:ZipEightByteInteger The relative header offset stored in this extra field.

getRelativeHeaderOffset

back to summary

public ZipEightByteInteger getRelativeHeaderOffset()

The relative header offset stored in this extra field.

Returns:ZipEightByteInteger: The relative header offset stored in this extra field.

getSize	back to summary
public ZipEightByteInteger getSize() The uncompressed size stored in this extra field. Returns:ZipEightByteInteger The uncompressed size stored in this extra field.

getSize

back to summary

public ZipEightByteInteger getSize()

The uncompressed size stored in this extra field.

Returns:ZipEightByteInteger: The uncompressed size stored in this extra field.

parseFromCentralDirectoryData	back to summary
public void parseFromCentralDirectoryData(final byte[] buffer, int offset, final int length) throws ZipException Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromCentralDirectoryData. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromCentralDirectoryData. Populate data from this array as if it was in central directory data. Parameters buffer:byte[] the buffer to read data from offset:int offset into buffer to read data length:int the length of data Annotations @Override Exceptions ZipException: on error

parseFromCentralDirectoryData

back to summary

public void parseFromCentralDirectoryData(final byte[] buffer, int offset, final int length) throws ZipException

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromCentralDirectoryData.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromCentralDirectoryData.

Populate data from this array as if it was in central directory data.

Parameters

buffer:byte[]: the buffer to read data from
offset:int: offset into buffer to read data
length:int: the length of data

Annotations

@Override

Exceptions

ZipException:: on error

parseFromLocalFileData	back to summary
public void parseFromLocalFileData(final byte[] buffer, int offset, final int length) throws ZipException Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromLocalFileData. Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromLocalFileData. Populate data from this array as if it was in local file data. Parameters buffer:byte[] the buffer to read data from offset:int offset into buffer to read data length:int the length of data Annotations @Override Exceptions ZipException: on error

parseFromLocalFileData

back to summary

public void parseFromLocalFileData(final byte[] buffer, int offset, final int length) throws ZipException

Implements org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromLocalFileData.

Doc from org.apache.commons.compress.archivers.zip.ZipExtraField.parseFromLocalFileData.

Populate data from this array as if it was in local file data.

Parameters

buffer:byte[]: the buffer to read data from
offset:int: offset into buffer to read data
length:int: the length of data

Annotations

@Override

Exceptions

ZipException:: on error

reparseCentralDirectoryData	back to summary
public void reparseCentralDirectoryData(final boolean hasUncompressedSize, final boolean hasCompressedSize, final boolean hasRelativeHeaderOffset, final boolean hasDiskStart) throws ZipException Parses the raw bytes read from the central directory extra field with knowledge which fields are expected to be there. All four fields inside the zip64 extended information extra field are optional and must only be present if their corresponding entry inside the central directory contains the correct magic value. Parameters hasUncompressedSize:boolean flag to read from central directory hasCompressedSize:boolean flag to read from central directory hasRelativeHeaderOffset:boolean flag to read from central directory hasDiskStart:boolean flag to read from central directory Exceptions ZipException: on error

reparseCentralDirectoryData

back to summary

public void reparseCentralDirectoryData(final boolean hasUncompressedSize, final boolean hasCompressedSize, final boolean hasRelativeHeaderOffset, final boolean hasDiskStart) throws ZipException

Parses the raw bytes read from the central directory extra field with knowledge which fields are expected to be there.

All four fields inside the zip64 extended information extra field are optional and must only be present if their corresponding entry inside the central directory contains the correct magic value.

Parameters

hasUncompressedSize:boolean: flag to read from central directory
hasCompressedSize:boolean: flag to read from central directory
hasRelativeHeaderOffset:boolean: flag to read from central directory
hasDiskStart:boolean: flag to read from central directory

Exceptions

ZipException:: on error

setCompressedSize	back to summary
public void setCompressedSize(final ZipEightByteInteger compressedSize) The uncompressed size stored in this extra field. Parameters compressedSize:ZipEightByteInteger The uncompressed size stored in this extra field.

setCompressedSize

back to summary

public void setCompressedSize(final ZipEightByteInteger compressedSize)

The uncompressed size stored in this extra field.

Parameters

compressedSize:ZipEightByteInteger: The uncompressed size stored in this extra field.

setDiskStartNumber	back to summary
public void setDiskStartNumber(final ZipLong ds) The disk start number stored in this extra field. Parameters ds:ZipLong The disk start number stored in this extra field.

setDiskStartNumber

back to summary

public void setDiskStartNumber(final ZipLong ds)

The disk start number stored in this extra field.

Parameters

ds:ZipLong: The disk start number stored in this extra field.

setRelativeHeaderOffset	back to summary
public void setRelativeHeaderOffset(final ZipEightByteInteger rho) The relative header offset stored in this extra field. Parameters rho:ZipEightByteInteger The relative header offset stored in this extra field.

setRelativeHeaderOffset

back to summary

public void setRelativeHeaderOffset(final ZipEightByteInteger rho)

The relative header offset stored in this extra field.

Parameters

rho:ZipEightByteInteger: The relative header offset stored in this extra field.

setSize	back to summary
public void setSize(final ZipEightByteInteger size) The uncompressed size stored in this extra field. Parameters size:ZipEightByteInteger The uncompressed size stored in this extra field.

setSize

back to summary

public void setSize(final ZipEightByteInteger size)

The uncompressed size stored in this extra field.

Parameters

size:ZipEightByteInteger: The uncompressed size stored in this extra field.

public Class Zip64ExtendedInformationExtraField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail