com.atlassian.jira.issue.attachment

Class AttachmentZipKit

java.lang.Object

com.atlassian.jira.issue.attachment.AttachmentZipKit

Deprecated.

Use AttachmentIndexManager instead. Since v6.4.

@Deprecated
public class AttachmentZipKit
extends Object

This class will help when working with zip files

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttachmentZipKit.AttachmentZipEntries Deprecated. Use AttachmentIndexManager instead. Since v6.4.
static interface	AttachmentZipKit.AttachmentZipEntry Deprecated. Use AttachmentIndexManager instead. Since v6.4.
static class	AttachmentZipKit.FileCriteria Deprecated. Use AttachmentIndexManager instead. Since v6.4.
static class	AttachmentZipKit.ZipEntryInputStream Deprecated.

Constructor Summary

Constructors

Constructor and Description
AttachmentZipKit() Deprecated.

Method Summary

Modifier and Type	Method and Description
AttachmentZipKit.ZipEntryInputStream	extractFile(File zipFile, long entryIndex) Deprecated. Use AttachmentIndexManager.getAttachmentContents(Attachment, com.atlassian.jira.issue.Issue, int) instead. Since v6.4.
boolean	isZip(File file) Deprecated. Use AttachmentIndexManager.isExpandable(Attachment) instead. Since v6.4.
AttachmentZipKit.AttachmentZipEntries	listEntries(File zipFile, int maxEntries, AttachmentZipKit.FileCriteria criteria) Deprecated. Use AttachmentIndexManager instead. Since v6.4.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentZipKit

public AttachmentZipKit()

Deprecated.

Method Detail

isZip

@Deprecated
public boolean isZip(@Nullable
                                 File file)

Deprecated. Use AttachmentIndexManager.isExpandable(Attachment) instead. Since v6.4.

This will return true if the file is in fact a valid zip file.

Parameters:

file - the file in play.

Returns:

true if its actually a readable zip file.

extractFile

@Deprecated
public AttachmentZipKit.ZipEntryInputStream extractFile(@Nullable
                                                                    File zipFile,
                                                                    long entryIndex)
                                                             throws IOException

Deprecated. Use AttachmentIndexManager.getAttachmentContents(Attachment, com.atlassian.jira.issue.Issue, int) instead. Since v6.4.

This will extract an OutputStream of the contents of the file at entryIndex within the zip file. If no file can be found be at that entryIndex or the entry is a directory then null will be returned.

Parameters:

zipFile - the zip file in play

entryIndex - the entryIndex of the entry to return

Returns:

an AttachmentZipKit.ZipEntryInputStream that can be read from for data and has extra ZipArchiveEntry information.

Throws:

IOException - if things go wrong during reading

listEntries

@Deprecated
public AttachmentZipKit.AttachmentZipEntries listEntries(File zipFile,
                                                                     int maxEntries,
                                                                     AttachmentZipKit.FileCriteria criteria)
                                                              throws IOException

Deprecated. Use AttachmentIndexManager instead. Since v6.4.

This will return a list of AttachmentZipKit.AttachmentZipEntrys for a given zip file

Parameters:

zipFile - the ZIP file in play

criteria - the criteria of which entries to return

maxEntries - the maximum number of entries to put in th list. If this is -negative then not maximum is used.

Returns:

a list of entries

Throws:

IOException - if the file cant be read or is not a zip. file.