A tiny, formatter-friendly Java DSL for creating ZIP files.
The ZIP Forge API consists of only 3 methods.
Applying a code formatter like palantir-java-format won't mess up ZIP Forge's indentation.
ZIP Forge is based on Java's ZIP File System Provider and requires no external dependencies.
ZIP Forge is published as a Java 9 module.
<dependency> <groupId>io.github.helpermethod</groupId> <artifactId>zip-forge</artifactId> <version>2.0.0</version> </dependency>implementation 'io.github.helpermethod:zip-forge:2.0.0'implementation("io.github.helpermethod:zip-forge:2.0.0")The following code snippet calls createZipFile to create the ZIP file at the given location. It uses the file and directory methods to create files and directories within the context of the ZIP file.
Warning
file and directory should never be used outside of createZipFile's or directory's context.
importjava.nio.charset.StandardCharsets; importstaticio.github.helpermethod.zipforge.ZipForge.createZipFile; importstaticio.github.helpermethod.zipforge.ZipForge.file; importstaticio.github.helpermethod.zipforge.ZipForge.directory; importstaticjava.nio.charset.StandardCharsets.UTF_8; classZipForgeDemo{publicstaticvoidmain(String[] args) throwsIOException{// creates a ZIP file named demo.zip in the /home/helpermethod directorycreateZipFile(Paths.get("/home/helpermethod/demo.zip"), () ->{// the file content can be specified as a String...file("a.txt", "a"); directory("d", () ->{// ... or a byte[]...file("b.txt", "b".getBytes(UTF_8)); // ... or a Pathfile("c.bin", Paths.get("c.bin")); // directories can be nesteddirectory("e", () ->{file("f.txt", "f")})})})} }The above code results in a ZIP file with the following structure.
Archive: demo.zip Length Date Time Name --------- ---------- ----- ---- 0 07-11-2023 15:39 d/ 0 07-11-2023 15:39 d/e/ 1 07-11-2023 15:39 a.txt 1 07-11-2023 15:39 d/b.txt 1 07-11-2023 15:39 d/c.bin 1 07-11-2023 15:39 d/e/f.txt --------- ------- 4 6 files The same example written in Kotlin. It uses the same API as the Java version.
importio.github.helpermethod.zipforge.ZipForge.createZipFileimportio.github.helpermethod.zipforge.ZipForge.directoryimportio.github.helpermethod.zipforge.ZipForge.fileimportkotlin.io.path.Pathfunmain(){createZipFile(Path("/home/helpermethod/demo.zip")){file("a.txt", "a") directory("d"){file("b.txt", "b".toByteArray()) file("c.bin", Path("c.bin")) directory("e"){file("f.txt", "f") } } } }