org.kepler.util

Class FileUtil

java.lang.Object

org.kepler.util.FileUtil

public class FileUtil
extends java.lang.Object

A place to keep some useful file processing static utility methods.

Author:

Aaron Schultz

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendNewLine(java.lang.String s)
static java.lang.String	clean(java.io.File f) Always return the true unique string representation of a file with no trailing separators.
static java.lang.String	convertStreamToString(java.io.InputStream is)
static void	copyDirectory(java.io.File sourceLocation, java.io.File targetLocation, boolean overwrite) Copy a file or directory to another.
static java.lang.String	getExtension(java.io.File f)
static java.lang.String	getFileNameWithoutExtension(java.lang.String filename) Return filename without extension.
static java.io.File	getHighestRankedFile(java.lang.String relativePath) Return the highest ranked (i.e. top override) of the given relative file path.
static java.io.File	getResourceAsFile(java.lang.Object relativeTo, java.lang.String relativePath) Get a File object from a resource on the classpath using the ClassLoader that loaded the given object.
static boolean	isSubdirectory(java.io.File base, java.io.File sub)
static java.lang.String[]	pathRep(java.io.File f) Return a string array representation of the file path.
static java.lang.String	readFileAsString(java.io.File file) Read in a file as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtil

public FileUtil()

Method Detail

getHighestRankedFile

public static java.io.File getHighestRankedFile(java.lang.String relativePath)

Return the highest ranked (i.e. top override) of the given relative file path.

Parameters:

relativePath -

Returns:

getResourceAsFile

public static java.io.File getResourceAsFile(java.lang.Object relativeTo,
                                             java.lang.String relativePath)

Get a File object from a resource on the classpath using the ClassLoader that loaded the given object.

Parameters:

relativeTo -

relativePath -

Returns:

readFileAsString

public static java.lang.String readFileAsString(java.io.File file)
                                         throws java.io.IOException

Read in a file as a string.

Parameters:

f -

Returns:

Throws:

java.io.IOException

convertStreamToString

public static java.lang.String convertStreamToString(java.io.InputStream is)
                                              throws java.io.IOException

Throws:

java.io.IOException

appendNewLine

public static java.lang.String appendNewLine(java.lang.String s)

isSubdirectory

public static boolean isSubdirectory(java.io.File base,
                                     java.io.File sub)
                              throws java.io.IOException

Parameters:

base -

sub -

Returns:

true if sub is a subdirectory of base

Throws:

java.io.IOException

pathRep

public static java.lang.String[] pathRep(java.io.File f)
                                  throws java.io.IOException

Return a string array representation of the file path.

Parameters:

f -

Returns:

Throws:

java.io.IOException

clean

public static java.lang.String clean(java.io.File f)
                              throws java.io.IOException

Always return the true unique string representation of a file with no trailing separators.

Parameters:

f -

Returns:

Throws:

java.io.IOException

getFileNameWithoutExtension

public static java.lang.String getFileNameWithoutExtension(java.lang.String filename)

Return filename without extension.

Parameters:

filename -

Returns:

getExtension

public static java.lang.String getExtension(java.io.File f)

copyDirectory

public static void copyDirectory(java.io.File sourceLocation,
                                 java.io.File targetLocation,
                                 boolean overwrite)
                          throws java.io.IOException

Copy a file or directory to another. If the source is a directory, the contents are recursively copied.

Parameters:

sourceLocation - the source

targetLocation - the destination

overwrite - If true, overwrite files in the targetLocation

Throws:

java.io.IOException