org.vishia.zip

Class Zip

java.lang.Object

org.vishia.zip.Zip

public class Zip
extends java.lang.Object

This class supports creating a jar file and working with zip files using the standard java zip methods. This class supports a base path and wildcards like described in FileFunctions.addFilesWithBasePath(File, String, List).

Usage template:

    Zip zip = new Zip();   //instance can be re-used in the same thread.
    zip.addSource(directory, path);
    zip.addSource(directory2, path2);
    String sError = zip.exec(dst, compressionLevel, comment);
    //the added sources are processed and removed.
    //next usage:
    zip.addSource(directory, path);
    String sError = zip.exec(dst, compressionLevel, comment);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Zip.Args This class holds arguments to zip.
(package private) static class	Zip.Src

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bsort
private java.util.List<Zip.Src>	listSrc
private java.util.jar.Manifest	manifest A manifest file.
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
Zip() Creates an empty instance for Zip.

Method Summary

Modifier and Type	Method and Description
void	addSource(java.io.File dir, java.lang.String src) Adds a source file or some files designated with wildcards
void	addSource(java.lang.String src) Adds a source file or some files designated with wildcards
java.lang.String	exec(java.io.File fileZip, int compressionLevel, java.lang.String comment, long timestamp) Executes the creation of zip or jar with the given source files to a dst file.
java.lang.String	exec(Zip.Args args) Executes Zip with given arguments.
static void	main(java.lang.String[] args) Invocation from java command line Zip routine from Java made by HSchorrig, 2013-02-09 - 2020-06-09 obligate arguments: -o:ZIP.zip { INPUT} -compress:0..9 set the compression rate 0=non .. 9=max -o:ZIP.zip file path for zip output -sort sorts entries with path -time:yyyy-MM-dd+hh:mm sets a timestamp for all entries in UTC (GMT) -timeformat:yyyy-MM-dd+hh:mm is default, can define other format, see java.text.SimpleDataFormat -manifest: if given creates a jar file INPUT file possible with localpath-separation and wildcards as "path:** /dir* /name*.ext*" For possibilities of the inputpath see FileFunctions.addFilesWithBasePath(File, String, List)
void	setManifest(java.io.File fileManifest) Sets a manifest information from a given file.
static int	smain(java.lang.String[] args) Main routine able to call inside another java process without exit VM.
static void	unzip(java.io.InputStream in)
static java.lang.String	zipfiles(java.io.File dst, java.io.File srcdir, java.lang.String sPath, int compressionLevel, java.lang.String comment) Zips some files in a dst file.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2020-03-20 Hartmut improvements and extensions for jar, especially sort and time stamp
• 2014-06-15 Hartmut new: Supports jar
• 2013-02-09 Hartmut chg: Cmdline#argList now handled in MainCmd#setArguments(org.vishia.mainCmd.MainCmd.Argument[]).
• 2013-01-20 Hartmut creation: New idea to use the zip facility of Java.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

listSrc

private final java.util.List<Zip.Src> listSrc

manifest

private java.util.jar.Manifest manifest

A manifest file. If it is set then a jar file will be created instead zip.

bsort

private boolean bsort

Constructor Detail

Zip

public Zip()

Creates an empty instance for Zip. One should call addSource(String) or addSource(File, String) and then #exec(File, int, String) to create a Zipfile.

The instance can be reused: After exec(...) the added sources are removed. call addSource(String) and #exec(File, int, String) with other files.

The instance should not be used in multithreading uncoordinated.

Method Detail

addSource

public void addSource(java.lang.String src)

Adds a source file or some files designated with wildcards

Parameters:

src - Path may contain the basebase:localpath separatet with ':'. The localpath is used inside the zip file as file tree. The localpath may contain wildcards. The basepath may be an absolute path or it is located in the systems current directory.. If the sPath does not contain a basepath (especially it is a simple path to a file), this path is used in the zipfile. Especially the path can start from the current directory. For usage of basepath, localpath and wildcards see FileFunctions.addFilesWithBasePath(File, String, List).

addSource

public void addSource(java.io.File dir,
                      java.lang.String src)

Adds a source file or some files designated with wildcards

Parameters:

dir - the directory where the source path starts.

src - Path may contain a basebase:localpath separatet with ':'. The localpath is used inside the zip file as file tree. The localpath may contain wildcards. If the sPath does not contain a basepath (especially it is a simple path to a file), this path is used in the zipfile. For usage of basepath, localpath and wildcards see FileFunctions.addFilesWithBasePath(File, String, List).

setManifest

public void setManifest(java.io.File fileManifest)
                 throws java.io.IOException

Sets a manifest information from a given file. If this routine are invoked before #exec(File, int, String), a jar file will be created with this manifest. If the fileManifest does not contain a version info, the Attributes.Name#MANIFEST_VERSION with the value "1.0" will be written.

Parameters:

fileManifest - a textual manifest file.

Throws:

java.io.IOException - file not found, any file error.

exec

public java.lang.String exec(java.io.File fileZip,
                             int compressionLevel,
                             java.lang.String comment,
                             long timestamp)
                      throws java.io.IOException

Executes the creation of zip or jar with the given source files to a dst file. If setManifest(File) was invoked before, a jar file will be created. All source files should be set with addSource(File, String) or addSource(String).

Parameters:

fileZip - The destination file.

compressionLevel - Level from 0..9 for compression

comment - in the zip file.

Returns:

an error hint of file errors or null if successful.

Throws:

java.io.IOException - on any file error. Note: If a given source file was not found, it was ignored but write as return hint.

unzip

public static void unzip(java.io.InputStream in)
                  throws java.io.IOException

Throws:

java.io.IOException

exec

public java.lang.String exec(Zip.Args args)
                      throws java.io.IOException

Executes Zip with given arguments. Note: One can have add sources calling addSource(String) before additional to the sources in add. But usual the sources should be given only in args.

Invoke:

 Zip zip = new Zip();
 Zip.Args args = .... get args from somewhere
 zip.exec(args);

Parameters:

args -

Returns:

Throws:

java.io.IOException

zipfiles

public static java.lang.String zipfiles(java.io.File dst,
                                        java.io.File srcdir,
                                        java.lang.String sPath,
                                        int compressionLevel,
                                        java.lang.String comment)
                                 throws java.io.IOException

Zips some files in a dst file.

Parameters:

dst - The destination file.

sPath - Path should contain the basebase:localpath separatet with ':'. The localpath is used inside the zip file as file tree. For usage of basepath, localpath see FileFunctions.addFilesWithBasePath(File, String, List).

compressionLevel - Level from 0..9 for compression

comment - in the zip file.

Returns:

an error hint or null if successful.

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

Invocation from java command line Zip routine from Java made by HSchorrig, 2013-02-09 - 2020-06-09

• obligate arguments: -o:ZIP.zip { INPUT}
• -compress:0..9 set the compression rate 0=non .. 9=max
• -o:ZIP.zip file path for zip output
• -sort sorts entries with path
• -time:yyyy-MM-dd+hh:mm sets a timestamp for all entries in UTC (GMT)
• -timeformat:yyyy-MM-dd+hh:mm is default, can define other format, see java.text.SimpleDataFormat
• -manifest: if given creates a jar file
• INPUT file possible with localpath-separation and wildcards as "path:** /dir* /name*.ext*"
• For possibilities of the inputpath see FileFunctions.addFilesWithBasePath(File, String, List)

Parameters:

args - command line arguments

smain

public static int smain(java.lang.String[] args)

Main routine able to call inside another java process without exit VM.

Parameters:

args - cmd line args adequate main(String[])

Returns:

exit code