com.fr.zip4j.core

类 ZipFileForPlugin

java.lang.Object

com.fr.zip4j.core.ZipFileForPlugin

public class ZipFileForPlugin
extends java.lang.Object

仅供压缩插件使用 Created by Handsome on 2017/10/16.

构造器概要

构造器

构造器和说明
ZipFileForPlugin(java.io.File zipFile) Creates a new Zip File Object with the input file.
ZipFileForPlugin(java.lang.String zipFile) Creates a new Zip File Object with the given zip file path.

方法概要

方法

限定符和类型	方法和说明
void	addFile(java.io.File sourceFile, ZipParameters parameters) Adds input source file to the zip file.
void	addFiles(java.util.ArrayList sourceFileList, ZipParameters parameters) Adds the list of input files to the zip file.
void	addFolder(java.io.File path, ZipParameters parameters) Adds the folder in the given file object to the zip file.
void	addFolder(java.lang.String path, ZipParameters parameters) Adds the folder in the given path to the zip file.
void	addStream(java.io.InputStream inputStream, ZipParameters parameters) Creates a new entry in the zip file and adds the content of the inputstream to the zip file.
void	createZipFile(java.util.ArrayList sourceFileList, ZipParameters parameters) Creates a zip file and adds the list of source file(s) to the zip file.
void	createZipFile(java.util.ArrayList sourceFileList, ZipParameters parameters, boolean splitArchive, long splitLength) Creates a zip file and adds the list of source file(s) to the zip file.
void	createZipFile(java.io.File sourceFile, ZipParameters parameters) Creates a zip file and adds the source file to the zip file.
void	createZipFile(java.io.File sourceFile, ZipParameters parameters, boolean splitArchive, long splitLength) Creates a zip file and adds the source file to the zip file.
void	createZipFileFromFolder(java.io.File folderToAdd, ZipParameters parameters, boolean splitArchive, long splitLength) Creates a zip file and adds the files/folders from the specified folder to the zip file.
void	createZipFileFromFolder(java.lang.String folderToAdd, ZipParameters parameters, boolean splitArchive, long splitLength) Creates a zip file and adds the files/folders from the specified folder to the zip file.
void	extractAll(java.lang.String destPath) Extracts all the files in the given zip file to the input destination path.
void	extractAll(java.lang.String destPath, UnzipParameters unzipParameters) Extracts all the files in the given zip file to the input destination path.
void	extractFile(FileHeader fileHeader, java.lang.String destPath) Extracts a specific file from the zip file to the destination path.
void	extractFile(FileHeader fileHeader, java.lang.String destPath, UnzipParameters unzipParameters) Extracts a specific file from the zip file to the destination path.
void	extractFile(FileHeader fileHeader, java.lang.String destPath, UnzipParameters unzipParameters, java.lang.String newFileName) Extracts a specific file from the zip file to the destination path.
void	extractFile(java.lang.String fileName, java.lang.String destPath) Extracts a specific file from the zip file to the destination path.
void	extractFile(java.lang.String fileName, java.lang.String destPath, UnzipParameters unzipParameters) Extracts a specific file from the zip file to the destination path.
void	extractFile(java.lang.String fileName, java.lang.String destPath, UnzipParameters unzipParameters, java.lang.String newFileName) Extracts a specific file from the zip file to the destination path.
java.lang.String	getComment() Returns the comment set for the Zip file
java.lang.String	getComment(java.lang.String encoding) Returns the comment set for the Zip file in the input encoding
java.io.File	getFile() Returns the File object of the zip file
FileHeader	getFileHeader(java.lang.String fileName) Returns FileHeader if a file header with the given fileHeader string exists in the zip model: If not returns null
java.util.List	getFileHeaders() Returns the list of file headers in the zip file.
ZipInputStream	getInputStream(FileHeader fileHeader) Returns an input stream for reading the contents of the Zip file corresponding to the input FileHeader.
ProgressMonitor	getProgressMonitor()
java.util.ArrayList	getSplitZipFiles() Returns the full file path+names of all split zip files in an ArrayList.
boolean	isEncrypted() Checks to see if the zip file is encrypted
boolean	isRunInThread()
boolean	isSplitArchive() Checks if the zip file is a split archive
boolean	isValidZipFile() Checks to see if the input zip file is a valid zip file.
void	mergeSplitFiles(java.io.File outputZipFile) Merges split zip files into a single zip file without the need to extract the files in the archive
void	removeFile(FileHeader fileHeader) Removes the file provided in the input file header from the zip file.
void	removeFile(java.lang.String fileName) Removes the file provided in the input paramters from the zip file.
void	setComment(java.lang.String comment) Sets comment for the Zip file
void	setFileNameCharset(java.lang.String charsetName) Zip4j will encode all the file names with the input charset.
void	setPassword(char[] password) Sets the password for the zip file
void	setPassword(java.lang.String password) Sets the password for the zip file.
void	setRunInThread(boolean runInThread)

从类继承的方法 java.lang.Object

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

构造器详细资料

ZipFileForPlugin

public ZipFileForPlugin(java.lang.String zipFile)
                 throws ZipException

Creates a new Zip File Object with the given zip file path. If the zip file does not exist, it is not created at this point.

参数:

zipFile -

抛出:

ZipException

ZipFileForPlugin

public ZipFileForPlugin(java.io.File zipFile)
                 throws ZipException

Creates a new Zip File Object with the input file. If the zip file does not exist, it is not created at this point.

参数:

zipFile -

抛出:

ZipException

方法详细资料

createZipFile

public void createZipFile(java.io.File sourceFile,
                 ZipParameters parameters)
                   throws ZipException

Creates a zip file and adds the source file to the zip file. If the zip file exists then this method throws an exception. Parameters such as compression type, etc can be set in the input parameters

参数:

sourceFile - - File to be added to the zip file

parameters - - parameters to create the zip file

抛出:

ZipException

createZipFile

public void createZipFile(java.io.File sourceFile,
                 ZipParameters parameters,
                 boolean splitArchive,
                 long splitLength)
                   throws ZipException

Creates a zip file and adds the source file to the zip file. If the zip file exists then this method throws an exception. Parameters such as compression type, etc can be set in the input parameters. While the method addFile/addFiles also creates the zip file if it does not exist, the main functionality of this method is to create a split zip file. To create a split zip file, set the splitArchive parameter to true with a valid splitLength. Split Length has to be more than 65536 bytes

参数:

sourceFile - - File to be added to the zip file

parameters - - parameters to create the zip file

splitArchive - - if archive has to be split or not

splitLength - - if archive has to be split, then length in bytes at which it has to be split

抛出:

ZipException

createZipFile

public void createZipFile(java.util.ArrayList sourceFileList,
                 ZipParameters parameters)
                   throws ZipException

Creates a zip file and adds the list of source file(s) to the zip file. If the zip file exists then this method throws an exception. Parameters such as compression type, etc can be set in the input parameters

参数:

sourceFileList - - File to be added to the zip file

parameters - - parameters to create the zip file

抛出:

ZipException

createZipFile

public void createZipFile(java.util.ArrayList sourceFileList,
                 ZipParameters parameters,
                 boolean splitArchive,
                 long splitLength)
                   throws ZipException

Creates a zip file and adds the list of source file(s) to the zip file. If the zip file exists then this method throws an exception. Parameters such as compression type, etc can be set in the input parameters. While the method addFile/addFiles also creates the zip file if it does not exist, the main functionality of this method is to create a split zip file. To create a split zip file, set the splitArchive parameter to true with a valid splitLength. Split Length has to be more than 65536 bytes

参数:

sourceFileList - - File to be added to the zip file

parameters - - zip parameters for this file list

splitArchive - - if archive has to be split or not

splitLength - - if archive has to be split, then length in bytes at which it has to be split

抛出:

ZipException

createZipFileFromFolder

public void createZipFileFromFolder(java.lang.String folderToAdd,
                           ZipParameters parameters,
                           boolean splitArchive,
                           long splitLength)
                             throws ZipException

Creates a zip file and adds the files/folders from the specified folder to the zip file. This method does the same functionality as in addFolder method except that this method can also create split zip files when adding a folder. To create a split zip file, set the splitArchive parameter to true and specify the splitLength. Split length has to be more than or equal to 65536 bytes. Note that this method throws an exception if the zip file already exists.

参数:

folderToAdd -

parameters -

splitArchive -

splitLength -

抛出:

ZipException

createZipFileFromFolder

public void createZipFileFromFolder(java.io.File folderToAdd,
                           ZipParameters parameters,
                           boolean splitArchive,
                           long splitLength)
                             throws ZipException

Creates a zip file and adds the files/folders from the specified folder to the zip file. This method does the same functionality as in addFolder method except that this method can also create split zip files when adding a folder. To create a split zip file, set the splitArchive parameter to true and specify the splitLength. Split length has to be more than or equal to 65536 bytes. Note that this method throws an exception if the zip file already exists.

参数:

folderToAdd -

parameters -

splitArchive -

splitLength -

抛出:

ZipException

addFile

public void addFile(java.io.File sourceFile,
           ZipParameters parameters)
             throws ZipException

Adds input source file to the zip file. If zip file does not exist, then this method creates a new zip file. Parameters such as compression type, etc can be set in the input parameters.

参数:

sourceFile - - File to tbe added to the zip file

parameters - - zip parameters for this file

抛出:

ZipException

addFiles

public void addFiles(java.util.ArrayList sourceFileList,
            ZipParameters parameters)
              throws ZipException

Adds the list of input files to the zip file. If zip file does not exist, then this method creates a new zip file. Parameters such as compression type, etc can be set in the input parameters.

参数:

sourceFileList -

parameters -

抛出:

ZipException

addFolder

public void addFolder(java.lang.String path,
             ZipParameters parameters)
               throws ZipException

Adds the folder in the given path to the zip file. If zip file does not exist, then a new zip file is created. If input folder path is invalid then an exception is thrown. Zip parameters for the files in the folder to be added can be set in the input parameters

参数:

path -

parameters -

抛出:

ZipException

addFolder

public void addFolder(java.io.File path,
             ZipParameters parameters)
               throws ZipException

Adds the folder in the given file object to the zip file. If zip file does not exist, then a new zip file is created. If input folder is invalid then an exception is thrown. Zip parameters for the files in the folder to be added can be set in the input parameters

参数:

path -

parameters -

抛出:

ZipException

addStream

public void addStream(java.io.InputStream inputStream,
             ZipParameters parameters)
               throws ZipException

Creates a new entry in the zip file and adds the content of the inputstream to the zip file. ZipParameters.isSourceExternalStream and ZipParameters.fileNameInZip have to be set before in the input parameters. If the file name ends with / or \, this method treats the content as a directory. Setting the flag ProgressMonitor.setRunInThread to true will have no effect for this method and hence this method cannot be used to add content to zip in thread mode

参数:

inputStream -

parameters -

抛出:

ZipException

extractAll

public void extractAll(java.lang.String destPath)
                throws ZipException

Extracts all the files in the given zip file to the input destination path. If zip file does not exist or destination path is invalid then an exception is thrown.

参数:

destPath -

抛出:

ZipException

extractAll

public void extractAll(java.lang.String destPath,
              UnzipParameters unzipParameters)
                throws ZipException

Extracts all the files in the given zip file to the input destination path. If zip file does not exist or destination path is invalid then an exception is thrown.

参数:

destPath -

unzipParameters -

抛出:

ZipException

extractFile

public void extractFile(FileHeader fileHeader,
               java.lang.String destPath)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. If destination path is invalid, then this method throws an exception.

参数:

fileHeader -

destPath -

抛出:

ZipException

extractFile

public void extractFile(FileHeader fileHeader,
               java.lang.String destPath,
               UnzipParameters unzipParameters)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. If destination path is invalid, then this method throws an exception.

If newFileName is not null or empty, newly created file name will be replaced by the value in newFileName. If this value is null, then the file name will be the value in FileHeader.getFileName

参数:

fileHeader -

destPath -

unzipParameters -

抛出:

ZipException

extractFile

public void extractFile(FileHeader fileHeader,
               java.lang.String destPath,
               UnzipParameters unzipParameters,
               java.lang.String newFileName)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. If destination path is invalid, then this method throws an exception.

参数:

fileHeader -

destPath -

unzipParameters -

newFileName -

抛出:

ZipException

extractFile

public void extractFile(java.lang.String fileName,
               java.lang.String destPath)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. This method first finds the necessary file header from the input file name.

File name is relative file name in the zip file. For example if a zip file contains a file "a.txt", then to extract this file, input file name has to be "a.txt". Another example is if there is a file "b.txt" in a folder "abc" in the zip file, then the input file name has to be abc/b.txt

Throws an exception if file header could not be found for the given file name or if the destination path is invalid

参数:

fileName -

destPath -

抛出:

ZipException

extractFile

public void extractFile(java.lang.String fileName,
               java.lang.String destPath,
               UnzipParameters unzipParameters)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. This method first finds the necessary file header from the input file name.

File name is relative file name in the zip file. For example if a zip file contains a file "a.txt", then to extract this file, input file name has to be "a.txt". Another example is if there is a file "b.txt" in a folder "abc" in the zip file, then the input file name has to be abc/b.txt

Throws an exception if file header could not be found for the given file name or if the destination path is invalid

参数:

fileName -

destPath -

unzipParameters -

抛出:

ZipException

extractFile

public void extractFile(java.lang.String fileName,
               java.lang.String destPath,
               UnzipParameters unzipParameters,
               java.lang.String newFileName)
                 throws ZipException

Extracts a specific file from the zip file to the destination path. This method first finds the necessary file header from the input file name.

File name is relative file name in the zip file. For example if a zip file contains a file "a.txt", then to extract this file, input file name has to be "a.txt". Another example is if there is a file "b.txt" in a folder "abc" in the zip file, then the input file name has to be abc/b.txt

If newFileName is not null or empty, newly created file name will be replaced by the value in newFileName. If this value is null, then the file name will be the value in FileHeader.getFileName

Throws an exception if file header could not be found for the given file name or if the destination path is invalid

参数:

fileName -

destPath -

unzipParameters -

newFileName -

抛出:

ZipException

setPassword

public void setPassword(java.lang.String password)
                 throws ZipException

Sets the password for the zip file.
Note: For security reasons, usage of this method is discouraged. Use setPassword(char[]) instead. As strings are immutable, they cannot be wiped out from memory explicitly after usage. Therefore, usage of Strings to store passwords is discouraged. More info here: http://docs.oracle.com/javase/1.5.0/docs/guide/security/jce/JCERefGuide.html#PBEEx

参数:

password -

抛出:

ZipException

setPassword

public void setPassword(char[] password)
                 throws ZipException

Sets the password for the zip file

参数:

password -

抛出:

ZipException

getFileHeaders

public java.util.List getFileHeaders()
                              throws ZipException

Returns the list of file headers in the zip file. Throws an exception if the zip file does not exist

返回:

list of file headers

抛出:

ZipException

getFileHeader

public FileHeader getFileHeader(java.lang.String fileName)
                         throws ZipException

Returns FileHeader if a file header with the given fileHeader string exists in the zip model: If not returns null

参数:

fileName -

返回:

FileHeader

抛出:

ZipException

isEncrypted

public boolean isEncrypted()
                    throws ZipException

Checks to see if the zip file is encrypted

返回:

true if encrypted, false if not

抛出:

ZipException

isSplitArchive

public boolean isSplitArchive()
                       throws ZipException

Checks if the zip file is a split archive

返回:

true if split archive, false if not

抛出:

ZipException

removeFile

public void removeFile(java.lang.String fileName)
                throws ZipException

Removes the file provided in the input paramters from the zip file. This method first finds the file header and then removes the file. If file does not exist, then this method throws an exception. If zip file is a split zip file, then this method throws an exception as zip specification does not allow for updating split zip archives.

参数:

fileName -

抛出:

ZipException

removeFile

public void removeFile(FileHeader fileHeader)
                throws ZipException

Removes the file provided in the input file header from the zip file. If zip file is a split zip file, then this method throws an exception as zip specification does not allow for updating split zip archives.

参数:

fileHeader -

抛出:

ZipException

mergeSplitFiles

public void mergeSplitFiles(java.io.File outputZipFile)
                     throws ZipException

Merges split zip files into a single zip file without the need to extract the files in the archive

参数:

outputZipFile -

抛出:

ZipException

setComment

public void setComment(java.lang.String comment)
                throws ZipException

Sets comment for the Zip file

参数:

comment -

抛出:

ZipException

getComment

public java.lang.String getComment()
                            throws ZipException

Returns the comment set for the Zip file

返回:

String

抛出:

ZipException

getComment

public java.lang.String getComment(java.lang.String encoding)
                            throws ZipException

Returns the comment set for the Zip file in the input encoding

参数:

encoding -

返回:

String

抛出:

ZipException

setFileNameCharset

public void setFileNameCharset(java.lang.String charsetName)
                        throws ZipException

Zip4j will encode all the file names with the input charset. This method throws an exception if the Charset is not supported

参数:

charsetName -

抛出:

ZipException

getInputStream

public ZipInputStream getInputStream(FileHeader fileHeader)
                              throws ZipException

Returns an input stream for reading the contents of the Zip file corresponding to the input FileHeader. Throws an exception if the FileHeader does not exist in the ZipFile

参数:

fileHeader -

返回:

ZipInputStream

抛出:

ZipException

isValidZipFile

public boolean isValidZipFile()

Checks to see if the input zip file is a valid zip file. This method will try to read zip headers. If headers are read successfully, this method returns true else false

返回:

boolean

从以下版本开始:

1.2.3

getSplitZipFiles

public java.util.ArrayList getSplitZipFiles()
                                     throws ZipException

Returns the full file path+names of all split zip files in an ArrayList. For example: If a split zip file(abc.zip) has a 10 split parts this method returns an array list with path + "abc.z01", path + "abc.z02", etc. Returns null if the zip file does not exist

返回:

ArrayList of Strings

抛出:

ZipException

getProgressMonitor

public ProgressMonitor getProgressMonitor()

isRunInThread

public boolean isRunInThread()

setRunInThread

public void setRunInThread(boolean runInThread)

getFile

public java.io.File getFile()

Returns the File object of the zip file

返回:

File