com.github.fge.filesystem

Class MoreFileSystems

java.lang.Object

com.github.fge.filesystem.MoreFileSystems

@ParametersAreNonnullByDefault
public final class MoreFileSystems
extends Object

Utility class for FileSystems

This utility class offers methods to:

• open zip files as file systems (therefore including jars, wars etc);
• wrap existing file systems in a read only wrapper.

It is the user's responsibility to close the filesystems returned by these methods.

Unless otherwise noted, all methods in this class do not accept null arguments and will throw a NullPointerException if a null argument is passed to them.

Method Summary

Methods

Modifier and Type	Method and Description
static FileSystem	createZip(Path path) Create a new zip file as a filesystem
static FileSystem	openZip(Path path, boolean readOnly) Open a zip as a file system, read write or read only
static FileSystem	readOnly(FileSystem fs) Return a read only version of a filesystem, if necessary

Methods inherited from class java.lang.Object

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

Method Detail

openZip

@Nonnull
@WillNotClose
public static FileSystem openZip(Path path,
                                      boolean readOnly)
                          throws IOException

Open a zip as a file system, read write or read only

Note that if it is determined that the zip file is not writable by the current user, the file system will be read only even if the readOnly argument is false.

Parameters:

path - the path to the zip

readOnly - whether the zip should be opened read only

Returns:

the filesystem

Throws:

FileSystemNotFoundException - zip does not exist

IOException - failed to open the path as a zip filesystem

createZip

@Nonnull
@WillNotClose
public static FileSystem createZip(Path path)
                            throws IOException

Create a new zip file as a filesystem

Parameters:

path - the path to the zip to create

Returns:

a filesystem

Throws:

FileAlreadyExistsException - zip file already exists

IOException - other errors

readOnly

@Nonnull
@WillNotClose
public static FileSystem readOnly(FileSystem fs)

Return a read only version of a filesystem, if necessary

If the filesystem given as an argument is already read only (ie, FileSystem.isReadOnly() returns true), this method will return the filesystem itself.

Parameters:

fs - the filesystem

Returns:

a read only filesystem