com.screenscraper.util

Class FileUtils

java.lang.Object

com.screenscraper.util.FileUtils

public class FileUtils
extends java.lang.Object

Various file-related utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static void	copyDir(java.io.File fromDir, java.io.File toDir) Copies the contents of one directory over the contents of another directory.
static void	copyFile(java.io.File in, java.io.File out) Copies a file.
static boolean	copyFile(java.io.File from, java.io.File to, long start) Copies a file from one location to another, leaving the old copy where it was.
static void	deleteDir(java.io.File dir) Deletes a directory, including all files and sub-directories contained within it.
static void	deleteFile(java.io.File file) Deletes a file, if it exists.
static java.lang.String	getFileExtension(java.io.File f) Returns the file extension for the given File as a String, or an empty String if the File has no extension.
static java.lang.String	getFileExtension(java.lang.String path) Returns the file extension for the File at the given path as a String, or an empty String if the File has no extension.
static java.io.File[]	getFilesFromDirectory(java.io.File directory) Returns a list of all files that are children of the given directory.
static int	getImageHeight(java.lang.String imagePath) Gets the height of an image.
static int	getImageWidth(java.lang.String imagePath) Gets the width of an image.
static void	resizeImage(java.lang.String originalFile, java.lang.String thumbnailFile, int newWidthSize, int newHeightSize, boolean deleteOriginalFile) Creates a thumbnail for an existing image.
static void	unzipFile(java.io.File zippedFile) Unzips a file.
static void	unzipFile(java.io.File zippedFile, java.io.File dir) Unzips the given zip archive to the given directory.
static void	zipDirectory(java.io.File zipFile, java.io.File rootDirectory, boolean deleteAfterAdd) Zips a directory (including all subdirectories)
static void	zipDirectory(java.io.File zipFile, java.lang.String rootDirectory, boolean deleteAfterAdd) Zips a directory (including all subdirectories)
static void	zipDirectory(java.lang.String zipFile, java.io.File rootDirectory, boolean deleteAfterAdd) Zips a directory (including all subdirectories)
static void	zipDirectory(java.lang.String zipFile, java.lang.String rootDirectory, boolean deleteAfterAdd) Zips a directory (including all subdirectories)
static void	zipFiles(java.io.File zipFile, java.io.File[] filesToZip, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.io.File zipFile, java.io.File[] filesToZip, java.io.File rootDirectory) Zips a list of files
static void	zipFiles(java.io.File zipFile, java.io.File[] filesToZip, java.io.File rootDirectory, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.io.File zipFile, java.io.File[] filesToZip, java.lang.String rootDirectory) Zips a list of files
static void	zipFiles(java.io.File zipFile, java.io.File[] filesToZip, java.lang.String rootDirectory, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.io.File zipFile, java.lang.String rootDirectory)
static void	zipFiles(java.lang.String zipFile, java.io.File[] filesToZip, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.lang.String zipFile, java.io.File[] filesToZip, java.lang.String rootDirectory, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.lang.String zipFile, java.lang.String[] filesToZip, boolean deleteAfterAdd) Zips a list of files
static void	zipFiles(java.lang.String zipFile, java.lang.String[] filesToZip, java.lang.String rootDirectory) Zips a list of files
static void	zipFiles(java.lang.String zipFile, java.lang.String[] filesToZip, java.lang.String rootDirectory, boolean deleteAfterAdd) Zips a list of files

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

FileUtils

public FileUtils()

Method Detail

deleteFile

public static void deleteFile(@NotNull
                              java.io.File file)

Deletes a file, if it exists.

Parameters:

file - The file to delete

copyFile

public static void copyFile(@NotNull
                            java.io.File in,
                            @NotNull
                            java.io.File out)

Copies a file.

Parameters:

in - The file to be read in.

out - The file to be written out.

unzipFile

public static void unzipFile(@NotNull
                             java.io.File zippedFile)
                      throws java.io.IOException

Unzips a file.

Parameters:

zippedFile - The archive to unzip.

Throws:

java.io.IOException - If an error occurs while unzipping the file

unzipFile

public static void unzipFile(@NotNull
                             java.io.File zippedFile,
                             @NotNull
                             java.io.File dir)
                      throws java.io.IOException

Unzips the given zip archive to the given directory.

Parameters:

zippedFile - the archive to unzip.

dir - the directory to unzip the archive to.

Throws:

java.io.IOException

copyDir

public static void copyDir(@NotNull
                           java.io.File fromDir,
                           java.io.File toDir)

Copies the contents of one directory over the contents of another directory.

Parameters:

fromDir - The directory to copy from.

toDir - The directory to copy to.

deleteDir

public static void deleteDir(@NotNull
                             java.io.File dir)

Deletes a directory, including all files and sub-directories contained within it.

Parameters:

dir - The directory to delete.

resizeImage

public static void resizeImage(@NotNull
                               java.lang.String originalFile,
                               @NotNull
                               java.lang.String thumbnailFile,
                               int newWidthSize,
                               int newHeightSize,
                               boolean deleteOriginalFile)
                        throws java.lang.Exception

Creates a thumbnail for an existing image. If an exception occurs in the process the original file will not be deleted.

Parameters:

originalFile - The path to the original file.

thumbnailFile - The path where the thumbnail should be created.

newWidthSize - The new width of the image.

newHeightSize - The new height of the image.

deleteOriginalFile - Whether or not the original file should be deleted after the thumbnail is created.

Throws:

java.lang.Exception - If an error occurrs while resizing the image

getImageHeight

public static int getImageHeight(@NotNull
                                 java.lang.String imagePath)
                          throws java.lang.Exception

Gets the height of an image.

Parameters:

imagePath - The path to the image.

Returns:

An int, representing the height of the image.

Throws:

java.lang.Exception - On error reading the image

getImageWidth

public static int getImageWidth(@NotNull
                                java.lang.String imagePath)
                         throws java.lang.Exception

Gets the width of an image.

Parameters:

imagePath - The path to the image.

Returns:

An int, representing the width of the image.

Throws:

java.lang.Exception - On error reading the image

copyFile

public static boolean copyFile(@NotNull
                               java.io.File from,
                               @NotNull
                               java.io.File to,
                               long start)

Copies a file from one location to another, leaving the old copy where it was.

Parameters:

from - The file to be copied

to - The file to copy into. This should be the full name, not just the directory.

start - The starting location in the file for the copy

Returns:

True if the copy was successful, false otherwise

zipFiles

public static void zipFiles(java.lang.String zipFile,
                            @Nullable
                            java.lang.String[] filesToZip,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.lang.String zipFile,
                            java.io.File[] filesToZip,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.io.File zipFile,
                            java.io.File[] filesToZip,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.lang.String zipFile,
                            @Nullable
                            java.lang.String[] filesToZip,
                            java.lang.String rootDirectory)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.io.File zipFile,
                            java.io.File[] filesToZip,
                            java.lang.String rootDirectory)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.io.File zipFile,
                            java.lang.String rootDirectory)
                     throws java.io.IOException

Throws:

java.io.IOException

zipFiles

public static void zipFiles(java.io.File zipFile,
                            java.io.File[] filesToZip,
                            java.io.File rootDirectory)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.io.File zipFile,
                            java.io.File[] filesToZip,
                            java.lang.String rootDirectory,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.lang.String zipFile,
                            java.io.File[] filesToZip,
                            java.lang.String rootDirectory,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipFiles

public static void zipFiles(java.lang.String zipFile,
                            @Nullable
                            java.lang.String[] filesToZip,
                            java.lang.String rootDirectory,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

zipDirectory

public static void zipDirectory(java.lang.String zipFile,
                                java.lang.String rootDirectory,
                                boolean deleteAfterAdd)
                         throws java.io.IOException

Zips a directory (including all subdirectories)

Parameters:

zipFile - The zip file to save to

rootDirectory - The directory to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

zipDirectory

public static void zipDirectory(java.io.File zipFile,
                                java.lang.String rootDirectory,
                                boolean deleteAfterAdd)
                         throws java.io.IOException

Zips a directory (including all subdirectories)

Parameters:

zipFile - The zip file to save to

rootDirectory - The directory to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

zipDirectory

public static void zipDirectory(java.io.File zipFile,
                                java.io.File rootDirectory,
                                boolean deleteAfterAdd)
                         throws java.io.IOException

Zips a directory (including all subdirectories)

Parameters:

zipFile - The zip file to save to

rootDirectory - The directory to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

zipDirectory

public static void zipDirectory(java.lang.String zipFile,
                                java.io.File rootDirectory,
                                boolean deleteAfterAdd)
                         throws java.io.IOException

Zips a directory (including all subdirectories)

Parameters:

zipFile - The zip file to save to

rootDirectory - The directory to compress

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

getFilesFromDirectory

@InternalOnly
public static java.io.File[] getFilesFromDirectory(java.io.File directory)

Returns a list of all files that are children of the given directory.

Parameters:

directory - the directory.

Returns:

the list of files.

zipFiles

public static void zipFiles(@Nullable
                            java.io.File zipFile,
                            @Nullable
                            java.io.File[] filesToZip,
                            @Nullable
                            java.io.File rootDirectory,
                            boolean deleteAfterAdd)
                     throws java.io.IOException

Zips a list of files

Parameters:

zipFile - The zip file to save to

filesToZip - The file to compress

rootDirectory - The root directory for the zip file, or null to ignore directory structure

deleteAfterAdd - If true, will delete the file after compressing it

Throws:

java.io.IOException - On error writing to the file

java.lang.IllegalArgumentException - If filesToZip is null or blank

getFileExtension

@NotNull
public static java.lang.String getFileExtension(@NotNull
                                                          java.io.File f)

Returns the file extension for the given File as a String, or an empty String if the File has no extension.

Parameters:

f - the file.

Returns:

the extension of the file.

getFileExtension

@NotNull
public static java.lang.String getFileExtension(java.lang.String path)

Returns the file extension for the File at the given path as a String, or an empty String if the File has no extension.

Parameters:

path - the path to the File.

Returns:

the extension of the file.