org.at4j.zip.ef

Class UnicodeCommentExtraFieldFactory

java.lang.Object

org.at4j.zip.ef.UnicodeCommentExtraFieldFactory

All Implemented Interfaces:

ZipEntryExtraFieldFactory

public class UnicodeCommentExtraFieldFactory
extends Object
implements ZipEntryExtraFieldFactory

This factory is used to create extra fields of the type UnicodeCommentExtraField.

Since:

1.0

Author:

Karl Gustafsson

Field Summary

Fields

Modifier and Type	Field and Description
static UnicodeCommentExtraFieldFactory	INSTANCE Singleton instance that may be used instead of instantiating this class.

Constructor Summary

Constructors

Constructor and Description
UnicodeCommentExtraFieldFactory()

Method Summary

Methods

Modifier and Type	Method and Description
UnicodeCommentExtraField	create(boolean inLocalHeader, org.entityfs.el.AbsoluteLocation loc, UnixEntityType entityType, Object entryToZip, 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.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final UnicodeCommentExtraFieldFactory INSTANCE

Singleton instance that may be used instead of instantiating this class.

Constructor Detail

UnicodeCommentExtraFieldFactory

public UnicodeCommentExtraFieldFactory()

Method Detail

getCode

public UnsignedShort getCode()

Description copied from interface: ZipEntryExtraFieldFactory

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

Specified by:

getCode in interface ZipEntryExtraFieldFactory

Returns:

The code.

create

public UnicodeCommentExtraField create(boolean inLocalHeader,
                              org.entityfs.el.AbsoluteLocation loc,
                              UnixEntityType entityType,
                              Object entryToZip,
                              ZipEntrySettings effectiveSettings)

Description copied from interface: ZipEntryExtraFieldFactory

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

Specified by:

create in interface ZipEntryExtraFieldFactory

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.

entryToZip - 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.