net.lenni0451.commons.io

Class FileSystemZip

java.lang.Object

net.lenni0451.commons.io.FileSystemZip

All Implemented Interfaces:

java.lang.AutoCloseable

public class FileSystemZip
extends java.lang.Object
implements java.lang.AutoCloseable

A fast zip file using the FileSystem API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FileSystemZip.Entry The entry for a file in the zip file.

Constructor Summary

Constructors

Constructor and Description
FileSystemZip(java.io.File file) Construct a new file system zip.

Method Summary

Modifier and Type	Method and Description
void	addDirectory(java.lang.String name) Add a directory to the zip file.
void	addEntry(java.lang.String name, byte[] bytes) Add an entry to the zip file.
void	close()
void	forEach(java.util.function.Consumer<FileSystemZip.Entry> consumer) Iterate over all entries in the zip file.
FileSystemZip.Entry	getEntry(java.lang.String name) Get an entry from the zip file.
java.io.File	getFile()
java.nio.file.Path	getRootPath()
boolean	hasDirectory(java.lang.String name) Check if an entry exists and is a directory.
boolean	hasEntry(java.lang.String name) Check if an entry exists.
boolean	hasFile(java.lang.String name) Check if an entry exists and is a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemZip

public FileSystemZip(java.io.File file)
              throws java.io.IOException,
                     java.net.URISyntaxException

Construct a new file system zip.
If the file does not exist a new zip file will be created.

Parameters:

file - The file to read/write

Throws:

java.io.IOException - If an I/O error occurs

java.net.URISyntaxException - If the file path is invalid

Method Detail

getFile

public java.io.File getFile()

Returns:

The file that is being read/written

getRootPath

public java.nio.file.Path getRootPath()

Returns:

The root path of the zip file

addEntry

public void addEntry(java.lang.String name,
                     @Nullable
                     byte[] bytes)
              throws java.io.IOException

Add an entry to the zip file.
If bytes is null a directory will be created.

Parameters:

name - The name of the entry

bytes - The data of the entry

Throws:

java.io.IOException - If an I/O error occurs

addDirectory

public void addDirectory(java.lang.String name)
                  throws java.io.IOException

Add a directory to the zip file.

Parameters:

name - The name of the directory

Throws:

java.io.IOException - If an I/O error occurs

getEntry

public FileSystemZip.Entry getEntry(java.lang.String name)
                             throws java.io.FileNotFoundException

Get an entry from the zip file.

Parameters:

name - The name of the entry

Returns:

The entry

Throws:

java.io.FileNotFoundException - If the entry does not exist

hasEntry

public boolean hasEntry(java.lang.String name)

Check if an entry exists.

Parameters:

name - The name of the entry

Returns:

If the entry exists

hasFile

public boolean hasFile(java.lang.String name)

Check if an entry exists and is a file.

Parameters:

name - The name of the entry

Returns:

If the entry exists

hasDirectory

public boolean hasDirectory(java.lang.String name)

Check if an entry exists and is a directory.

Parameters:

name - The name of the entry

Returns:

If the entry exists

forEach

public void forEach(java.util.function.Consumer<FileSystemZip.Entry> consumer)
             throws java.io.IOException

Iterate over all entries in the zip file.

Parameters:

consumer - The consumer to call for each entry

Throws:

java.io.IOException - If an I/O error occurs

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception