org.daisy.pipeline.client.utils

Class Files

java.lang.Object

org.daisy.pipeline.client.utils.Files

public class Files
extends Object

Utility class for working with files, especially ZIP-files. Based on: http://snippets.dzone.com/posts/show/3468 http://stackoverflow.com/a/8829253/281065 http://stackoverflow.com/a/1399432/281065 http://stackoverflow.com/a/2265206/281065

Constructor Summary

Constructors

Constructor and Description
Files()

Method Summary

Modifier and Type	Method and Description
static void	addDirectoryContentsToZip(File zipFile, File directory) Convenience method for addFilesToZip(File zipFile, Map<String,File> files) .
static void	addDirectoryToZip(File zipFile, File directory) Convenience method for addFilesToZip(File zipFile, Map<String,File> files) .
static void	addFilesToZip(File zipFile, File[] files, File baseDirectory) Convenience method for addFilesToZip(File zipFile, Map<String,File> files).
static void	addFilesToZip(File zipFile, Map<String,File> files) This is where the action happens.
static void	copy(File from, File to) Copy a file from one location to another
static String	encodeURI(String path) Encodes a file path for use as a URI.
static Map<String,File>	listFilesRecursively(File directory, boolean includeDirectories) Lists all files recursively, starting at `directory`.
static Map<String,File>	listFilesRecursively(File directory, URI base, boolean includeDirectories) Lists all files recursively, starting at `directory`, resolving their relative paths against `base`.
static List<String>	listZipFiles(File zipfile) Does not actually load the files, since that could potentially eat up your RAM.
static String	read(File file) Read text from file
static void	unzip(File zip, File dir) Unzip the ZIP-file `zip` to the directory `dir`.
static void	zip(File dir, File zip) Zip up the directory `dir` into a new ZIP-file `zip`.

Methods inherited from class java.lang.Object

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

Constructor Detail

Files

public Files()

Method Detail

addDirectoryToZip

public static void addDirectoryToZip(File zipFile,
                                     File directory)
                              throws IOException

Convenience method for addFilesToZip(File zipFile, Map<String,File> files) . Appends all the files in the `directory` into the `zipFile` with paths relative to `directory`s parent directory.

Parameters:

zipFile - The ZIP-file.

directory - The directory to add to the ZIP.

Throws:

IOException - thrown when an IOException occurs

addDirectoryContentsToZip

public static void addDirectoryContentsToZip(File zipFile,
                                             File directory)
                                      throws IOException

Convenience method for addFilesToZip(File zipFile, Map<String,File> files) . Appends all the files in the `directory` into the `zipFile` with paths relative to the `directory`.

Parameters:

zipFile - The ZIP-file.

directory - The directory to add to the ZIP.

Throws:

IOException - thrown when an IOException occurs

listFilesRecursively

public static Map<String,File> listFilesRecursively(File directory,
                                                    boolean includeDirectories)
                                             throws IOException

Lists all files recursively, starting at `directory`. This is the same as listFilesRecursively(File directory, URI base, boolean includeDirectories) except with directory and base pointing to the same directory.

Parameters:

directory - The directory

includeDirectories - whether or not to include the directories themselves in the result

Returns:

The set of files

Throws:

IOException - thrown when an IOException occurs

listFilesRecursively

public static Map<String,File> listFilesRecursively(File directory,
                                                    URI base,
                                                    boolean includeDirectories)
                                             throws IOException

Lists all files recursively, starting at `directory`, resolving their relative paths against `base`. The return value can be used as an argument for addFilesToZip(File zipFile, Map<String,File> files);

Parameters:

directory - The directory

base - The base URI

includeDirectories - whether or not to include the directories themselves in the result

Returns:

The set of files

Throws:

IOException - thrown when an IOException occurs

listZipFiles

public static List<String> listZipFiles(File zipfile)

Does not actually load the files, since that could potentially eat up your RAM. All File objects are set to null instead.

Parameters:

zipfile - The ZIP file

Returns:

A list of the files in the ZIP

addFilesToZip

public static void addFilesToZip(File zipFile,
                                 File[] files,
                                 File baseDirectory)
                          throws IOException

Convenience method for addFilesToZip(File zipFile, Map<String,File> files). Appends all the `files` into the `zipFile` with paths relative to `baseDirectory`.

Parameters:

zipFile - The ZIP-file.

files - The list of files to append to the ZIP-file.

baseDirectory - The directory to resolve the relative file paths against.

Throws:

IOException - thrown when an IOException occurs

addFilesToZip

public static void addFilesToZip(File zipFile,
                                 Map<String,File> files)
                          throws IOException

This is where the action happens. The other functions uses this one, but this can be used directly as well.

Parameters:

zipFile - The ZIP file.

files - A map of all the files to add to the ZIP file, where the key is the ZIP entry name to use (the relative file paths).

Throws:

IOException - thrown when an IOException occurs

unzip

public static void unzip(File zip,
                         File dir)
                  throws IOException

Unzip the ZIP-file `zip` to the directory `dir`.

Parameters:

zip - ZIP file

dir - output directory

Throws:

IOException - thrown when an IOException occurs

zip

public static void zip(File dir,
                       File zip)
                throws IOException

Zip up the directory `dir` into a new ZIP-file `zip`. If `dir` is a file, then only that single file is zipped.

Parameters:

dir - The directory

zip - The ZIP file

Throws:

IOException - thrown when an IOException occurs

copy

public static void copy(File from,
                        File to)
                 throws IOException

Copy a file from one location to another

Parameters:

from - Original location

to - Target location

Throws:

IOException - thrown when an IOException occurs

encodeURI

public static String encodeURI(String path)

Encodes a file path for use as a URI. The "/" directory separator is not escaped. Example: encodeURI("dir1/dir 2/file [ ]].xml") returns "dir1/dir%202/file%20%5B%20%20%5D%5D.xml"

Parameters:

path - The path

Returns:

The encoded URI

read

public static String read(File file)

Read text from file

Parameters:

file - The file to read

Returns:

The text contained in the file