com.kheops.util

Class KFileUtil

java.lang.Object

com.kheops.util.KFileUtil

public class KFileUtil
extends java.lang.Object

KFileUtil contains usefull methods for files manipulation.

Constructor Summary

Constructors

Constructor and Description
KFileUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	copyDirectory(java.io.File source, java.io.File dest) Copies the content of the source directory in the specified directory.
static boolean	copyDirectory(java.io.File source, java.io.File dest, boolean overwriteFile) Copies the content of the source directory in the specified directory.
static boolean	copyDirectory(java.io.File source, java.io.File dest, java.lang.String[] filters) Copies the content of the source directory in the specified directory.
static boolean	copyDirectory(java.io.File source, java.io.File dest, java.lang.String[] filters, boolean overwriteFile) Copies the content of the source directory in the specified directory.
static boolean	copyFile(java.io.File source, java.io.File dest) Copies the specifies source file to the destination file.
static boolean	copyFile(java.io.File source, java.io.File dest, boolean overwrite) Copies the specifies source file to the destination file.
static boolean	copyFile(java.lang.String source, java.lang.String dest) Copies the specifies source file to the destination file.
static boolean	copyFile(java.lang.String source, java.lang.String dest, boolean overwrite) Copies the specifies source file to the destination file.
static boolean	deleteDirectory(java.io.File dir) Deletes a directory recursively
static java.lang.String	getDatedFileName() Returns the current date formatted like: '2002-04-17'.
static java.lang.String	getFileContent(java.io.File f)
static java.util.jar.Attributes	getJarAttributesFromManifest(java.io.File file)
static java.io.File[]	listFiles(java.io.File dir, java.lang.String[] filters, boolean recursive) Lists all files matching the specified filters from the specified directory.
static java.io.File[]	listFiles(java.lang.String dir, java.lang.String[] filters) Lists all files matching the specified filters from the specified directory.
static java.io.File[]	listFiles(java.lang.String dir, java.lang.String[] filters, boolean recursive) Lists all files matching the specified filters from the specified directory.
static java.util.Properties	loadPropertiesFile(java.io.File file) Loads a Properties file.
static java.util.Properties	loadPropertiesFile(java.io.File file, java.nio.charset.Charset charset)
static byte[]	readFile(java.io.File file) Returns the content of the specified file.
static void	savePropertiesFile(java.util.Properties prop, java.io.File fileName, java.lang.String header)
static void	setFileContent(java.io.File f, byte[] buffer)
static void	setFileContent(java.io.File f, java.lang.String buffer)
static boolean	unzipFile(java.io.File source, java.io.File dest) Unzips the content of the specified compressed file to the specified destination directory.
static void	writeFile(java.io.File file, byte[] data)
static boolean	zipDirectory(java.io.File source, java.io.File dest, boolean recursive) Zips the content of the specified directory to the specified destination file.
static boolean	zipDirectory(java.io.File source, java.io.OutputStream stream, boolean recursive)

Methods inherited from class java.lang.Object

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

Constructor Detail

KFileUtil

public KFileUtil()

Method Detail

listFiles

public static java.io.File[] listFiles(java.lang.String dir,
                                       java.lang.String[] filters,
                                       boolean recursive)

Lists all files matching the specified filters from the specified directory. The filter '*' returns all files. ex.: listFiles(new File("c:/temp"), new String[]{"*"});

Parameters:

dir - the directory to list files from

filters - filters to match the files with

Returns:

all files matching the specified filter from the specified directory

listFiles

public static java.io.File[] listFiles(java.io.File dir,
                                       java.lang.String[] filters,
                                       boolean recursive)

Lists all files matching the specified filters from the specified directory. The filter '*' returns all files. ex.: listFiles(new File("c:/temp"), new String[]{"*"});

Parameters:

dir - the directory to list files from

filters - filters to match the files with

Returns:

all files matching the specified filter from the specified directory

listFiles

public static java.io.File[] listFiles(java.lang.String dir,
                                       java.lang.String[] filters)

Lists all files matching the specified filters from the specified directory. The filter '*' returns all files. ex.: listFiles(new File("c:/temp"), new String[]{"*"});

Parameters:

dir - the directory to list files from

filters - filters to match the files with

Returns:

all files matching the specified filter from the specified directory

readFile

public static byte[] readFile(java.io.File file)
                       throws java.io.IOException

Returns the content of the specified file.

Parameters:

file - the file to read from

Returns:

the content of the specified file

Throws:

java.io.IOException - if an error occurs

writeFile

public static void writeFile(java.io.File file,
                             byte[] data)
                      throws java.io.IOException

Throws:

java.io.IOException

copyDirectory

public static boolean copyDirectory(java.io.File source,
                                    java.io.File dest)
                             throws java.io.IOException

Copies the content of the source directory in the specified directory. If the destination doesn't exist, it will be created. File is overwritten if already exist

Throws:

java.io.IOException

copyDirectory

public static boolean copyDirectory(java.io.File source,
                                    java.io.File dest,
                                    boolean overwriteFile)
                             throws java.io.IOException

Copies the content of the source directory in the specified directory. If the destination doesn't exist, it will be created.

Parameters:

source - the source directory

dest - the destination directory

Returns:

true if the copy successful

Throws:

java.io.IOException - if an error occurs during the copy

copyDirectory

public static boolean copyDirectory(java.io.File source,
                                    java.io.File dest,
                                    java.lang.String[] filters)
                             throws java.io.IOException

Copies the content of the source directory in the specified directory. If the destination doesn't exist, it will be created. File is overwritten if already exist

Throws:

java.io.IOException

copyDirectory

public static boolean copyDirectory(java.io.File source,
                                    java.io.File dest,
                                    java.lang.String[] filters,
                                    boolean overwriteFile)
                             throws java.io.IOException

Copies the content of the source directory in the specified directory. If the destination doesn't exist, it will be created.

Parameters:

source - the source directory

dest - the destination directory

filters - list of file extensions to copy, others are ignored. (e.g. "gif", "png", etc.)

Returns:

true if the copy successful

Throws:

java.io.IOException - if an error occurs during the copy

unzipFile

public static boolean unzipFile(java.io.File source,
                                java.io.File dest)
                         throws java.io.IOException

Unzips the content of the specified compressed file to the specified destination directory.

Parameters:

source - the compressed file

dest - the destination directory.

Returns:

true if the operation completes successfully

Throws:

java.io.IOException - if an error occurs

zipDirectory

public static boolean zipDirectory(java.io.File source,
                                   java.io.File dest,
                                   boolean recursive)
                            throws java.io.IOException

Zips the content of the specified directory to the specified destination file.

Parameters:

source - the source directory

dest - the destination compressed file. If the file already exists, it will be overwritten.

recursive - zip the content of the source directory recursively

Returns:

true if the operation completes successfully

Throws:

java.io.IOException - if an error occurs

zipDirectory

public static boolean zipDirectory(java.io.File source,
                                   java.io.OutputStream stream,
                                   boolean recursive)
                            throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static boolean copyFile(java.lang.String source,
                               java.lang.String dest)
                        throws java.io.IOException

Copies the specifies source file to the destination file. File is overwritten if already exist

Throws:

java.io.IOException

copyFile

public static boolean copyFile(java.lang.String source,
                               java.lang.String dest,
                               boolean overwrite)
                        throws java.io.IOException

Copies the specifies source file to the destination file.

Parameters:

source - the file to be copied

dest - the destination file

Returns:

true if the operation completes successfully

Throws:

java.io.IOException - if an error occurs

copyFile

public static boolean copyFile(java.io.File source,
                               java.io.File dest)
                        throws java.io.IOException

Copies the specifies source file to the destination file. File is overwritten if already exist

Throws:

java.io.IOException

copyFile

public static boolean copyFile(java.io.File source,
                               java.io.File dest,
                               boolean overwrite)
                        throws java.io.IOException

Copies the specifies source file to the destination file.

Parameters:

source - the file to be copied

dest - the destination file

Returns:

true if the operation completes successfully

Throws:

java.io.IOException - if an error occurs

getDatedFileName

public static java.lang.String getDatedFileName()

Returns the current date formatted like: '2002-04-17'. This is the standard used for every dated files created by JMapServer.

Returns:

the current date formatted like: '2002-04-17'.

deleteDirectory

public static boolean deleteDirectory(java.io.File dir)

Deletes a directory recursively

Parameters:

dir - the directory to delete

loadPropertiesFile

public static java.util.Properties loadPropertiesFile(java.io.File file)

Loads a Properties file.

Parameters:

file - the Properties file to load.

Returns:

a Properties object or null if an error occurred.

loadPropertiesFile

public static java.util.Properties loadPropertiesFile(java.io.File file,
                                                      java.nio.charset.Charset charset)

savePropertiesFile

public static void savePropertiesFile(java.util.Properties prop,
                                      java.io.File fileName,
                                      java.lang.String header)

getFileContent

public static java.lang.String getFileContent(java.io.File f)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

setFileContent

public static void setFileContent(java.io.File f,
                                  byte[] buffer)
                           throws java.lang.Exception

Throws:

java.lang.Exception

setFileContent

public static void setFileContent(java.io.File f,
                                  java.lang.String buffer)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getJarAttributesFromManifest

public static java.util.jar.Attributes getJarAttributesFromManifest(java.io.File file)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception