org.gvsig.educa.portableview.impl.util

Class FileUtils

java.lang.Object

org.apache.commons.io.FileUtils

org.gvsig.educa.portableview.impl.util.FileUtils

public abstract class FileUtils
extends org.apache.commons.io.FileUtils

File utilities. Extends the provides by apache-common-IO

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	UNIXLIKE_FILESYSTEM

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static File	getNewFileName(File baseFolder, String name) Create File instance for a new file on a baseFolder starts with baseName.
static File	getNewWritableFolder(File baseFolder, String baseName) Create a new folder on a baseFolder starts with baseName which is new and writable.
static File	getRelativeTo(File path, File basePath) Return path as relative from basePath only if basePath is an ancestor of path:
static File	getWritableFolder(File baseFolder, String baseName) Look for a folder on a baseFolder starts with baseName which is writable.
static boolean	isReadableFile(File folder) Informs if file is a readable file ( exists & isFile & canRead)
static boolean	isReadableFolder(File folder) Informs if folder is a readable folder( exists & isDir & canRead)
static boolean	isWritableFolder(File folder) Informs if folder is a writable folder( exists & isDir & canWrite)
static void	unzipFile(File zipFile, File outputFloder) Unzip a file into a folder
static void	zipFolder(File rootFolder, File targetFile) Create a zip file which will contains all contents of a folder Files will be use relative path to rootFolder

Methods inherited from class java.lang.Object

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

Field Detail

UNIXLIKE_FILESYSTEM

public static final boolean UNIXLIKE_FILESYSTEM

Constructor Detail

FileUtils

public FileUtils()

Method Detail

unzipFile

public static void unzipFile(File zipFile,
                             File outputFloder)
                      throws ZipException,
                             IOException

Unzip a file into a folder

Parameters:

zipFile -

outputFloder - must exists. WARNING: Contents will be removed before unzip

Throws:

IOException

ZipException

IllegalArgumentException - if zipFile is not a file or outputFloder doesn't exists or is read-only

zipFolder

public static void zipFolder(File rootFolder,
                             File targetFile)
                      throws IOException

Create a zip file which will contains all contents of a folder

Files will be use relative path to rootFolder

Parameters:

rootFolder - rootFolder (must be an existing folder)

targetFile - final file (must not exists)

Throws:

IOException

IllegalArgumentException - if there are any problem in parameters

isWritableFolder

public static boolean isWritableFolder(File folder)

Informs if folder is a writable folder( exists & isDir & canWrite)

Parameters:

folder -

Returns:

isReadableFolder

public static boolean isReadableFolder(File folder)

Informs if folder is a readable folder( exists & isDir & canRead)

Parameters:

folder -

Returns:

isReadableFile

public static boolean isReadableFile(File folder)

Informs if file is a readable file ( exists & isFile & canRead)

Parameters:

folder -

Returns:

getWritableFolder

public static File getWritableFolder(File baseFolder,
                                     String baseName)

Look for a folder on a baseFolder starts with baseName which is writable.

The pattern is: baseFolder/baseName.0000 where 000 it's a counter.

Parameters:

baseFolder - existing and writable folder

baseName - start of new folder

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getNewWritableFolder

public static File getNewWritableFolder(File baseFolder,
                                        String baseName)

Create a new folder on a baseFolder starts with baseName which is new and writable.

The pattern is: baseFolder/baseName.0000 where 000 it's a counter.

Parameters:

baseFolder - existing and writable folder

baseName - start of new folder

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getNewFileName

public static File getNewFileName(File baseFolder,
                                  String name)

Create File instance for a new file on a baseFolder starts with baseName.

The pattern is: baseFolder/baseName.0000.ext where 000 it's a counter.

This no create the file into the file system.

Parameters:

baseFolder - existing and writable folder

name - start of new file

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getRelativeTo

public static File getRelativeTo(File path,
                                 File basePath)

Return path as relative from basePath only if basePath is an ancestor of path:

Parameters:

path -

basePath -

Returns:

See Also:

FilenameUtils.getRelativeTo(String, String)