org.apache.commons.compress.archivers.zip

Class AbstractUnicodeExtraField

java.lang.Object

org.apache.commons.compress.archivers.zip.AbstractUnicodeExtraField

All Implemented Interfaces:

ZipExtraField

Direct Known Subclasses:

UnicodeCommentExtraField, UnicodePathExtraField

public abstract class AbstractUnicodeExtraField
extends java.lang.Object
implements ZipExtraField

A common base class for Unicode extra information extra fields.

Field Summary

Fields inherited from interface org.apache.commons.compress.archivers.zip.ZipExtraField

EXTRAFIELD_HEADER_SIZE

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.
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.
long	getNameCRC32() Gets the CRC32 checksum of the file name or comment as encoded in the central directory of the ZIP file.
byte[]	getUnicodeName() Gets The UTF-8 encoded name.
void	parseFromCentralDirectoryData(byte[] buffer, int offset, int length) Doesn't do anything special since this class always uses the same data in central directory and local file data.
void	parseFromLocalFileData(byte[] buffer, int offset, int length) Populate data from this array as if it was in local file data.
void	setNameCRC32(long nameCRC32) Gets The CRC32 checksum of the file name as encoded in the central directory of the ZIP file to set.
void	setUnicodeName(byte[] unicodeName) Gets the UTF-8 encoded name to set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.compress.archivers.zip.ZipExtraField

getHeaderId

Method Detail

getCentralDirectoryData

public byte[] getCentralDirectoryData()

Description copied from interface: ZipExtraField

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

Specified by:

getCentralDirectoryData in interface ZipExtraField

Returns:

the data

getCentralDirectoryLength

public ZipShort getCentralDirectoryLength()

Description copied from interface: ZipExtraField

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

Specified by:

getCentralDirectoryLength in interface ZipExtraField

Returns:

the length of the field in the central directory

getLocalFileDataData

public byte[] getLocalFileDataData()

Description copied from interface: ZipExtraField

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

Specified by:

getLocalFileDataData in interface ZipExtraField

Returns:

the data

getLocalFileDataLength

public ZipShort getLocalFileDataLength()

Description copied from interface: ZipExtraField

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

Specified by:

getLocalFileDataLength in interface ZipExtraField

Returns:

the length of the field in the local file data

getNameCRC32

public long getNameCRC32()

Gets the CRC32 checksum of the file name or comment as encoded in the central directory of the ZIP file.

Returns:

The CRC32 checksum of the file name or comment as encoded in the central directory of the ZIP file.

getUnicodeName

public byte[] getUnicodeName()

Gets The UTF-8 encoded name.

Returns:

The UTF-8 encoded name.

parseFromCentralDirectoryData

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

Doesn't do anything special since this class always uses the same data in central directory and local file data.

Specified by:

parseFromCentralDirectoryData in interface ZipExtraField

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

parseFromLocalFileData

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

Description copied from interface: ZipExtraField

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

Specified by:

parseFromLocalFileData in interface ZipExtraField

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

setNameCRC32

public void setNameCRC32(long nameCRC32)

Gets The CRC32 checksum of the file name as encoded in the central directory of the ZIP file to set.

Parameters:

nameCRC32 - The CRC32 checksum of the file name as encoded in the central directory of the ZIP file to set.

setUnicodeName

public void setUnicodeName(byte[] unicodeName)

Gets the UTF-8 encoded name to set.

Parameters:

unicodeName - The UTF-8 encoded name to set.