org.teiid.core.util
Class FileUtils

java.lang.Object
  org.teiid.core.util.FileUtils

public final class FileUtils
extends Object

Nested Class Summary

static interface

FileUtils.Constants

Field Summary

static int	DEFAULT_BUFFER_SIZE
static String	JAVA_IO_TEMP_DIR
static String	LINE_SEPARATOR
static char[]	LINE_SEPARATOR_CHARS
static char	SEPARATOR
static char[]	SUFFIX_class
static char[]	SUFFIX_CLASS
static char[]	SUFFIX_jar
static char[]	SUFFIX_JAR
static char[]	SUFFIX_java
static char[]	SUFFIX_JAVA
static char[]	SUFFIX_zip
static char[]	SUFFIX_ZIP
static String	TEMP_DIRECTORY

Method Summary

static String	buildDirectoryPath(String[] paths) Builds a file directory path from a physical location and a location that needs to be appended to the physical.
static File	convertByteArrayToFile(byte[] contents, String parentDirectoryPath, String fileName)
static void	copy(String fromFileName, String toFileName) Copy a file.
static void	copy(String fromFileName, String toFileName, boolean overwrite) Copy a file
static void	copyDirectoriesRecursively(File sourceDirectory, File targetDirectory) Copy recursively the sourceDirectory and all its contents to the targetDirectory.
static void	copyDirectoryContentsRecursively(File sourceDirectory, File targetDirectory) Copy recursively the contents of sourceDirectory to the targetDirectory.
static void	copyFile(String orginDirectory, String destDirectory, String fileName) Copy file from orginating directory to the destination directory.
static void	copyFile(String orginDirectory, String orginFileName, String destDirectory, String destFileName) Copy file from orginating directory to the destination directory.
static File[]	findAllFilesInDirectory(String dir) Returns a File array that will contain all the files that exist in the directory
static File[]	findAllFilesInDirectoryHavingExtension(String dir, String extension) Returns a File array that will contain all the files that exist in the directory that have the specified extension.
static File[]	findAllFilesInDirectoryRecursively(String dir) Returns a File array that will contain all the files that exist in the specified directory or any nested directories
static String	getBaseFileNameWithoutExtension(String path)
static String	getExtension(File theFile) Obtains the file extension of the specified File.
static String	getExtension(String theFileName) Obtains the file extension of the specified file name.
static String	getFilenameWithoutExtension(String filename)
static boolean	isArchiveFileName(String name) Returns true iff str.toLowerCase().endsWith(".jar") || str.toLowerCase().endsWith(".zip") implementation is not creating extra strings.
static boolean	isClassFileName(String name) Returns true iff str.toLowerCase().endsWith(".class") implementation is not creating extra strings.
static boolean	isFilenameValid(String newName) Determine whether the specified name is valid for a file or folder on the current file system.
static boolean	isJavaFileName(String name) Returns true iff str.toLowerCase().endsWith(".java") implementation is not creating extra strings.
static void	remove(String filePath)
static void	removeChildrenRecursively(File directory)
static void	removeDirectoryAndChildren(File directory)
static void	rename(String oldFilePath, String newFilePath, boolean overwrite) Rename a file.
static void	testDirectoryPermissions(String dirPath) Test whether it's possible to read and write files in the specified directory.
static String	toFileNameWithExtension(String name, String extension) Convert the specified file name to end with the specified extension if it doesn't already end with an extension.
static String	toFileNameWithExtension(String name, String extension, boolean force) Convert the specified file name to end with the specified extension if it doesn't already end with an extension.
static void	write(byte[] data, File file) Write a byte array to a file.
static void	write(byte[] data, String fileName) Write a byte array to a file.
static void	write(File f, OutputStream outputStream) Write an File to an OutputStream Note: this will not close the outputStream;
static void	write(File f, OutputStream outputStream, int bufferSize) Write an File to an OutputStream Note: this will not close the outputStream;
static void	write(InputStream is, File f) Write an InputStream to a file.
static void	write(InputStream is, File f, int bufferSize) Write an InputStream to a file.
static void	write(InputStream fis, OutputStream outputStream, int bufferSize) Write the given input stream to outputstream Note: this will not close in/out streams
static void	write(InputStream is, String fileName) Write an InputStream to a file.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final char SEPARATOR

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static int DEFAULT_BUFFER_SIZE

TEMP_DIRECTORY

public static String TEMP_DIRECTORY

LINE_SEPARATOR

public static String LINE_SEPARATOR

LINE_SEPARATOR_CHARS

public static char[] LINE_SEPARATOR_CHARS

JAVA_IO_TEMP_DIR

public static final String JAVA_IO_TEMP_DIR

See Also:

Constant Field Values

SUFFIX_class

public static final char[] SUFFIX_class

SUFFIX_CLASS

public static final char[] SUFFIX_CLASS

SUFFIX_java

public static final char[] SUFFIX_java

SUFFIX_JAVA

public static final char[] SUFFIX_JAVA

SUFFIX_jar

public static final char[] SUFFIX_jar

SUFFIX_JAR

public static final char[] SUFFIX_JAR

SUFFIX_zip

public static final char[] SUFFIX_zip

SUFFIX_ZIP

public static final char[] SUFFIX_ZIP

Method Detail

toFileNameWithExtension

public static String toFileNameWithExtension(String name,
                                             String extension)

Convert the specified file name to end with the specified extension if it doesn't already end with an extension.

Parameters:

name - The file name.

extension - The extension to append to the file name.

Returns:

The file name with an extension.

Since:

4.0

toFileNameWithExtension

public static String toFileNameWithExtension(String name,
                                             String extension,
                                             boolean force)

Convert the specified file name to end with the specified extension if it doesn't already end with an extension. If force is true, the specified extension will be appended to the name if the name doesn't end with that particular extension.

Parameters:

name - The file name.

extension - The extension to append to the file name.

force - Indicates whether to force the specified extension as the extension of the file name.

Returns:

The file name with an extension.

Since:

4.0

isFilenameValid

public static boolean isFilenameValid(String newName)

Determine whether the specified name is valid for a file or folder on the current file system.

Parameters:

newName - the new name to be checked

Returns:

true if the name is null or contains no invalid characters for a folder or file, or false otherwise

copy

public static void copy(String fromFileName,
                        String toFileName)
                 throws IOException

Copy a file. Overwrites the destination file if it exists.

Parameters:

fromFileName -

toFileName -

Throws:

Exception

IOException

Since:

4.3

copy

public static void copy(String fromFileName,
                        String toFileName,
                        boolean overwrite)
                 throws IOException

Copy a file

Parameters:

fromFileName -

toFileName -

overwrite - whether to overwrite the destination file if it exists.

Throws:

TeiidException

IOException

Since:

4.3

copyDirectoryContentsRecursively

public static void copyDirectoryContentsRecursively(File sourceDirectory,
                                                    File targetDirectory)
                                             throws Exception

Copy recursively the contents of sourceDirectory to the targetDirectory. Note that sourceDirectory will NOT be copied. If targetDirectory does not exist, it will be created.

Parameters:

sourceDirectory - The source directory to copy

targetDirectory - The target directory to copy to

Throws:

Exception - If the source directory does not exist.

Since:

4.3

copyFile

public static void copyFile(String orginDirectory,
                            String destDirectory,
                            String fileName)
                     throws Exception

Copy file from orginating directory to the destination directory.

Parameters:

orginDirectory -

destDirectory -

fileName -

Throws:

Exception

Since:

4.4

copyFile

public static void copyFile(String orginDirectory,
                            String orginFileName,
                            String destDirectory,
                            String destFileName)
                     throws Exception

Copy file from orginating directory to the destination directory.

Parameters:

orginDirectory -

orginFileName -

destDirectory -

destFileName -

Throws:

Exception

Since:

4.4

copyDirectoriesRecursively

public static void copyDirectoriesRecursively(File sourceDirectory,
                                              File targetDirectory)
                                       throws Exception

Copy recursively the sourceDirectory and all its contents to the targetDirectory. If targetDirectory does not exist, it will be created.

Parameters:

sourceDirectory - The source directory to copy

targetDirectory - The target directory to copy to

Throws:

Exception - If the source directory does not exist.

Since:

4.3

write

public static void write(InputStream is,
                         String fileName)
                  throws IOException

Write an InputStream to a file.

Throws:

IOException

write

public static void write(InputStream is,
                         File f)
                  throws IOException

Write an InputStream to a file.

Throws:

IOException

write

public static void write(InputStream is,
                         File f,
                         int bufferSize)
                  throws IOException

Write an InputStream to a file.

Throws:

IOException

write

public static void write(File f,
                         OutputStream outputStream)
                  throws IOException

Write an File to an OutputStream Note: this will not close the outputStream;

Throws:

IOException

write

public static void write(File f,
                         OutputStream outputStream,
                         int bufferSize)
                  throws IOException

Write an File to an OutputStream Note: this will not close the outputStream;

Throws:

IOException

write

public static void write(InputStream fis,
                         OutputStream outputStream,
                         int bufferSize)
                  throws IOException

Write the given input stream to outputstream Note: this will not close in/out streams

Throws:

IOException

write

public static void write(byte[] data,
                         String fileName)
                  throws IOException

Write a byte array to a file.

Throws:

IOException

write

public static void write(byte[] data,
                         File file)
                  throws IOException

Write a byte array to a file.

Throws:

IOException

findAllFilesInDirectoryRecursively

public static File[] findAllFilesInDirectoryRecursively(String dir)

Returns a File array that will contain all the files that exist in the specified directory or any nested directories

Returns:

File[] of files in the directory

findAllFilesInDirectory

public static File[] findAllFilesInDirectory(String dir)

Returns a File array that will contain all the files that exist in the directory

Returns:

File[] of files in the directory

findAllFilesInDirectoryHavingExtension

public static File[] findAllFilesInDirectoryHavingExtension(String dir,
                                                            String extension)

Returns a File array that will contain all the files that exist in the directory that have the specified extension.

Returns:

File[] of files having a certain extension

getFilenameWithoutExtension

public static String getFilenameWithoutExtension(String filename)

Parameters:

string -

Returns:

getBaseFileNameWithoutExtension

public static String getBaseFileNameWithoutExtension(String path)

getExtension

public static String getExtension(File theFile)

Obtains the file extension of the specified File. The extension is considered to be all the characters after the last occurrence of FileUtils.Constants.FILE_EXTENSION_SEPARATOR_CHAR in the pathname of the input.

Parameters:

theFile - the file whose extension is being requested

Returns:

the extension or null if not found

Since:

4.2

getExtension

public static String getExtension(String theFileName)

Obtains the file extension of the specified file name. The extension is considered to be all the characters after the last occurrence of FileUtils.Constants.FILE_EXTENSION_SEPARATOR_CHAR.

Parameters:

theFileName - the file whose extension is being requested

Returns:

the extension or null if not found

Since:

4.2

isArchiveFileName

public static final boolean isArchiveFileName(String name)

Returns true iff str.toLowerCase().endsWith(".jar") || str.toLowerCase().endsWith(".zip") implementation is not creating extra strings.

isClassFileName

public static final boolean isClassFileName(String name)

Returns true iff str.toLowerCase().endsWith(".class") implementation is not creating extra strings.

isJavaFileName

public static final boolean isJavaFileName(String name)

Returns true iff str.toLowerCase().endsWith(".java") implementation is not creating extra strings.

convertByteArrayToFile

public static File convertByteArrayToFile(byte[] contents,
                                          String parentDirectoryPath,
                                          String fileName)

removeDirectoryAndChildren

public static void removeDirectoryAndChildren(File directory)

removeChildrenRecursively

public static void removeChildrenRecursively(File directory)

buildDirectoryPath

public static String buildDirectoryPath(String[] paths)

Builds a file directory path from a physical location and a location that needs to be appended to the physical. This is used so that the correct File.separator is used and that no additional separator is added when not needed.

Parameters:

physicalDirectory -

appendLocation -

Returns:

Since:

4.3

testDirectoryPermissions

public static void testDirectoryPermissions(String dirPath)
                                     throws TeiidException

Test whether it's possible to read and write files in the specified directory.

Parameters:

dirPath - Name of the directory to test

Throws:

TeiidException

Since:

4.3

rename

public static void rename(String oldFilePath,
                          String newFilePath,
                          boolean overwrite)
                   throws IOException

Rename a file.

Parameters:

oldFilePath -

newFilePath -

overwrite - If true, overwrite the old file if it exists. If false, throw an exception if the old file exists.

Throws:

TeiidException

IOException

Since:

4.3

remove

public static void remove(String filePath)
                   throws IOException

Throws:

IOException