org.at4j.zip.ef

Interface ZipEntryExtraFieldFactory

All Known Implementing Classes:

ExtendedTimestampExtraFieldFactory, InfoZipUnixExtraFieldFactory, NewInfoZipUnixExtraFieldFactory, NtfsExtraFieldFactory, UnicodeCommentExtraFieldFactory, UnicodePathExtraFieldFactory, UnparsedZipEntryExtraFieldFactory

public interface ZipEntryExtraFieldFactory

This factory is used to create Zip entry extra field objects when building Zip files.

Since:

1.0

Author:

Karl Gustafsson

See Also:

ZipEntryExtraField

Method Summary

Methods

Modifier and Type	Method and Description
ZipEntryExtraField	create(boolean inLocalHeader, org.entityfs.el.AbsoluteLocation loc, UnixEntityType entityType, Object entityToZip, ZipEntrySettings effectiveSettings) Create a new ZipEntryExtraField object based on the supplied information about the entity to Zip.
UnsignedShort	getCode() Get the code that identifies the kind of ZipEntryExtraField objects created by this factory in a Zip file.

Method Detail

getCode

UnsignedShort getCode()

Get the code that identifies the kind of ZipEntryExtraField objects created by this factory in a Zip file.

Returns:

The code.

create

ZipEntryExtraField create(boolean inLocalHeader,
                        org.entityfs.el.AbsoluteLocation loc,
                        UnixEntityType entityType,
                        Object entityToZip,
                        ZipEntrySettings effectiveSettings)

Create a new ZipEntryExtraField object based on the supplied information about the entity to Zip.

Parameters:

inLocalHeader - Should a local header or a central directory version of the extra field be created?

loc - The absolute location of the entry in the Zip file.

entityType - The type of entity to zip.

entityToZip - The file system entity to Zip. This may be a ReadableFile, a DirectoryView, a File directory or an InputStream. In the latter case, this method cannot read any data from the stream.

effectiveSettings - The effective settings for the entry.

Returns:

A Zip entry extra field.