fr.cnes.sitools.util
Class FileUtils

java.lang.Object
  fr.cnes.sitools.util.FileUtils

public final class FileUtils
extends java.lang.Object

Author:

Makoto YUI (yuin405+xbird@gmail.com)

Nested Class Summary

static class	FileUtils.AndFileFilter And file filter
static class	FileUtils.DirectoryFileFilter Directory file filter
static class	FileUtils.FalseFileFilter False filter
static interface	FileUtils.IOFileFilter Interface for File filters, joining both File and File name filters
static class	FileUtils.NameFileFilter Name file filter
static class	FileUtils.NotFileFilter Not file filter
static class	FileUtils.OrFileFilter Or file filter
static class	FileUtils.PrefixFileFilter Prefix filter
static class	FileUtils.SuffixFileFilter Suffic file filter
static class	FileUtils.TrueFileFilter Main file filter

Method Summary

static java.lang.String	basename(java.lang.String filepath) Get base name of the path
static java.lang.String	basename(java.lang.String filepath, char separator) Get base name of the path
static boolean	cleanDirectory(java.io.File dir, boolean deleteDir) Clean a directory
static void	cleanDirectory(java.io.File dir, java.lang.String[] suffixes, boolean recursive) Clean a directory
static void	closeQuietly(java.io.Closeable channel) Close a channel
static java.lang.String	dirName(java.lang.String filepath, char separatorChar) Get the directory name
static java.lang.String	getFileName(java.io.File file) Get the file name
static long	getFileSize(java.io.File file) Get the file size
static java.io.File	getTempDir() Get temporary director
static java.util.List<java.io.File>	listFiles(java.io.File directory, FileUtils.IOFileFilter fileFilter, FileUtils.IOFileFilter dirFilter) Finds files within a given directory (and optionally its subdirectories).
static java.util.List<java.io.File>	listFiles(java.io.File directory, java.lang.String[] suffixes, boolean recursive) Finds files within a given directory (and optionally its subdirectories) which match an array of suffixes.
static java.util.List<java.io.File>	listFiles(java.io.File directory, java.lang.String[] prefixes, java.lang.String[] suffixes, boolean recursive) Finds files within a given directory (and optionally its subdirectories) which match an array of suffixes.
static java.util.List<java.io.File>	listFiles(java.io.File directory, java.lang.String suffix, boolean recursive) Create a list of files
static void	truncateFile(java.io.File file) Truncate the file

Methods inherited from class java.lang.Object

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

Method Detail

getTempDir

public static java.io.File getTempDir()

Get temporary director

Returns:

a temp directory

getFileSize

public static long getFileSize(java.io.File file)

Get the file size

Parameters:

file - file to look at

Returns:

the size

listFiles

public static java.util.List<java.io.File> listFiles(java.io.File directory,
                                                     FileUtils.IOFileFilter fileFilter,
                                                     FileUtils.IOFileFilter dirFilter)

Finds files within a given directory (and optionally its subdirectories). All files found are filtered by an IOFileFilter.

Parameters:

directory - the directory to list

fileFilter - the filter file

dirFilter - the directory filter

Returns:

a list of files

listFiles

public static java.util.List<java.io.File> listFiles(java.io.File directory,
                                                     java.lang.String suffix,
                                                     boolean recursive)

Create a list of files

Parameters:

directory - to search in

suffix - the suffix to look for

recursive - true indicates recursive

Returns:

a list of files

listFiles

public static java.util.List<java.io.File> listFiles(java.io.File directory,
                                                     java.lang.String[] suffixes,
                                                     boolean recursive)

Finds files within a given directory (and optionally its subdirectories) which match an array of suffixes.

Parameters:

directory - File directory to clean up

suffixes - the suffixes to look for

recursive - true indicates recursive

Returns:

a list of files

listFiles

public static java.util.List<java.io.File> listFiles(java.io.File directory,
                                                     java.lang.String[] prefixes,
                                                     java.lang.String[] suffixes,
                                                     boolean recursive)

Finds files within a given directory (and optionally its subdirectories) which match an array of suffixes.

Parameters:

directory - to search in

prefixes - the prefixes to look for

suffixes - the suffixes to look for

recursive - true indicates recursive

Returns:

a list of files

cleanDirectory

public static void cleanDirectory(java.io.File dir,
                                  java.lang.String[] suffixes,
                                  boolean recursive)
                           throws java.io.IOException

Clean a directory

Parameters:

dir - the directory to clean

suffixes - the suffixes to delete

recursive - to clean specified directory and inner directories recursively

Throws:

java.io.IOException - when file exceptions occur

cleanDirectory

public static boolean cleanDirectory(java.io.File dir,
                                     boolean deleteDir)
                              throws java.io.IOException

Clean a directory

Parameters:

dir - the directory to clean

deleteDir - true to delete the directory, false otherwise

Returns:

true if the directory is correctly cleaned

Throws:

java.io.IOException - if reading directory fails

getFileName

public static java.lang.String getFileName(java.io.File file)

Get the file name

Parameters:

file - file to look at

Returns:

the file name

basename

public static java.lang.String basename(java.lang.String filepath)

Get base name of the path

Parameters:

filepath - the path to the file

Returns:

the base name

basename

public static java.lang.String basename(java.lang.String filepath,
                                        char separator)

Get base name of the path

Parameters:

filepath - the path to the file

separator - the separator to use

Returns:

the base name

dirName

public static java.lang.String dirName(java.lang.String filepath,
                                       char separatorChar)

Get the directory name

Parameters:

filepath - path of the directory

separatorChar - character of separation

Returns:

the directory name

truncateFile

public static void truncateFile(java.io.File file)

Truncate the file

Parameters:

file - file to truncate

closeQuietly

public static void closeQuietly(java.io.Closeable channel)

Close a channel

Parameters:

channel - channel to close