org.apache.commons.compress.archivers.zip

Interface ZipExtraField

All Known Implementing Classes:

AbstractUnicodeExtraField, AsiExtraField, JarMarker, PKWareExtraHeader, ResourceAlignmentExtraField, UnicodeCommentExtraField, UnicodePathExtraField, UnparseableExtraFieldData, UnrecognizedExtraField, X000A_NTFS, X0014_X509Certificates, X0015_CertificateIdForFile, X0016_CertificateIdForCentralDirectory, X0017_StrongEncryptionHeader, X0019_EncryptionRecipientCertificateList, X5455_ExtendedTimestamp, X7875_NewUnix, Zip64ExtendedInformationExtraField

public interface ZipExtraField

General format of extra field data.

Extra fields usually appear twice per file, once in the local file data and once in the central directory. Usually they are the same, but they don't have to be. java.util.zip.ZipOutputStream will only use the local file data in both places.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXTRAFIELD_HEADER_SIZE Size of an extra field field header (id + length).

Method Summary

Modifier and Type	Method and Description
byte[]	getCentralDirectoryData() The actual data to put into central directory - without Header-ID or length specifier.
ZipShort	getCentralDirectoryLength() Length of the extra field in the central directory - without Header-ID or length specifier.
ZipShort	getHeaderId() The Header-ID.
byte[]	getLocalFileDataData() The actual data to put into local file data - without Header-ID or length specifier.
ZipShort	getLocalFileDataLength() Length of the extra field in the local file data - without Header-ID or length specifier.
void	parseFromCentralDirectoryData(byte[] buffer, int offset, int length) Populate data from this array as if it was in central directory data.
void	parseFromLocalFileData(byte[] buffer, int offset, int length) Populate data from this array as if it was in local file data.

Field Detail

EXTRAFIELD_HEADER_SIZE

static final int EXTRAFIELD_HEADER_SIZE

Size of an extra field field header (id + length).

Since:

1.14

See Also:

Constant Field Values

Method Detail

getHeaderId

ZipShort getHeaderId()

The Header-ID.

Returns:

The HeaderId value

getLocalFileDataLength

ZipShort getLocalFileDataLength()

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

Returns:

the length of the field in the local file data

getCentralDirectoryLength

ZipShort getCentralDirectoryLength()

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

Returns:

the length of the field in the central directory

getLocalFileDataData

byte[] getLocalFileDataData()

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

Returns:

the data

getCentralDirectoryData

byte[] getCentralDirectoryData()

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

Returns:

the data

parseFromLocalFileData

void parseFromLocalFileData(byte[] buffer,
                            int offset,
                            int length)
                     throws java.util.zip.ZipException

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

Parameters:

buffer - the buffer to read data from

offset - offset into buffer to read data

length - the length of data

Throws:

java.util.zip.ZipException - on error

parseFromCentralDirectoryData

void parseFromCentralDirectoryData(byte[] buffer,
                                   int offset,
                                   int length)
                            throws java.util.zip.ZipException

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

Parameters:

buffer - the buffer to read data from

offset - offset into buffer to read data

length - the length of data

Throws:

java.util.zip.ZipException - on error