org.trianacode.taskgraph.util

Class FileUtils

java.lang.Object

org.trianacode.taskgraph.util.FileUtils

public class FileUtils
extends java.lang.Object

Class Description Here...

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCII
static int	BINARY

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	absolutePath(java.lang.String path)
static void	closeInputStream(java.io.DataInputStream di) Closes the given input stream.
static void	closeOutputStream(java.io.DataOutputStream dos) Closes the given output stream.
static void	closeReader(java.io.BufferedReader br) closes the given reader
static void	closeWriter(java.io.PrintWriter pw) closes the given writer
static java.lang.String	convertFromVirtualName(java.lang.String fileName) Convert machine independant form to actual fileName
static java.lang.String	convertToVirtualName(java.lang.String fileName) Convert the given fileName into a machine independant form by making use of the environment variables to set up relative paths etc.
static boolean	copyFile(java.lang.String loc1, java.lang.String loc2, int mode) As copyFile except that it doesn't confirm on replacing a file.
static boolean	copyFile(java.lang.String loc1, java.lang.String loc2, int mode, boolean confirmOnReplace) Copies the file from the first location to the second.
static java.util.List<java.io.File>	copyFilesRecursive(java.io.File src, java.io.File dest) Copies files and directories recursively.
static java.lang.String	correctURL(java.lang.String file) Converts a URL address which may have machine dependant path separators contained within it to an appropraite URL address e.g.
static java.io.DataInputStream	createInputStream(java.lang.String name) Creates a reader for a specified local or networked binary file.
static java.io.DataOutputStream	createOutputStream(java.lang.String name) Creates an output stream for a specified local or networked binary file.
static java.io.BufferedReader	createReader(java.lang.String name) creates a buffered reader for a specified local or networked text file.
static java.io.BufferedReader	createReader(java.net.URL url) creates a buffered reader for a URL
static java.io.PrintWriter	createWriter(java.lang.String name) creates a buffered writer for a specified local or networked text file.
static java.io.PrintWriter	createWriter(java.lang.String name, boolean append) creates a buffered writer for a specified local file, with an option to append.
static java.io.PrintWriter	createWriter(java.net.URL url) Creates a buffered writer to a specific URL.
static void	deleteFile(java.lang.String loc) Deletes the file at the given file location.
static void	deleteFiles(java.io.File parent, boolean incParent) deletes files recursively.
static boolean	fileExists(java.lang.String name) return true if the specified file (or Directory) exists either on a network or a local server.
static java.lang.String	formatThrowable(java.lang.Throwable t)
static java.applet.AudioClip	getAudioClip(java.lang.String audioFile) Loads in a sound file from the internet or local disk.
static java.applet.AudioClip	getAudioClip(java.net.URL audioLoc) Loads in a sound file from the specified internet location.
static java.lang.String	getFileNameNoSuffix(java.lang.String fullName)
static java.awt.Image	getImage(java.lang.String imageName) Loads in an image from the internet or local disk.
static java.applet.AudioClip	getSystemAudioClip(java.lang.String audioFile) Loads in a Triana system sound file via the internet (if it is an applet) or local disk.
static java.awt.Image	getSystemImage(java.lang.String imageName) Loads in a triana system image from the internet or local disk.
static javax.swing.ImageIcon	getSystemImageIcon(java.lang.String imageName) Loads in a triana system image icon from the internet or local disk.
static boolean	isDirectory(java.lang.String loc) Determines whether the file specified is a directory.
static boolean	isDirectory(java.net.URL loc) Determines whether the internet location and file specified is in fact a directory.
static boolean	isOnInternet(java.lang.String fileOrPath) Determines whether the given path or file is an internet address or not
static boolean	isParent(java.lang.String parent, java.lang.String child) Checks whether the child is contained by the parent directory.
static Listing	listAllFiles(java.lang.String searchdir, java.lang.String searchFilter, boolean recurseDirs) Gets a Listing Object for the given directory, the given searchstring (i.e.
static java.lang.String[]	listDir(java.lang.String dir) returns a list of file names in the given directory or returns null if the directory is empty or if it does not exist.
static Listing	listDir(java.lang.String dir, boolean recurse) Finds all file names in the specified directory and in all directories lower down in the tree.
static Listing	listDir(java.net.URL dir, boolean recurse) Finds all file names in the specified directory and in all directories lower down in the tree.
static Listing	listDirNames(java.lang.String searchdir, java.lang.String searchFilter, boolean recurseDirs) Gets a Listing Object for the given directory, the given searchstring (i.e.
static java.io.File[]	listEndsWith(java.lang.String baseDir, java.lang.String endsWith)
static java.io.File[]	listEndsWith(java.lang.String baseDir, java.lang.String[] endsWith, java.lang.String[] excludedir)
static java.io.File[]	listEndsWith(java.lang.String baseDir, java.lang.String endsWith, java.lang.String[] excludedir)
static Listing	listFileNames(java.lang.String searchdir, java.lang.String searchFilter, boolean recurseDirs) Gets a Listing Object for the given directory, the given searchstring (i.e.
static java.util.Vector<java.lang.String>	listInternetDirectory(java.net.URL loc) Lists the filenames and directories within a URL if that URL is a directory
static java.lang.String	nextNonEmptyLine(java.io.BufferedReader br) Skips the empty lines in a file and returns the next non-empty line or null if the end of the file is reached.
static java.util.Vector<java.lang.String>	nextNonEmptySplitLine(java.io.BufferedReader br) Skips the empty lines in a file and returns the next non-empty line or null if the end of the file is reached.
static void	playSystemAudio(java.lang.String audioFile) Plays a Triana system sound file by loading it across the internet (if Triana is an applet)or local disk.
static java.util.Vector<java.lang.String>	readAndSplitFile(java.io.BufferedReader br) This function splits the file into a vector of Strings, each item in the vector representing one line.
static java.util.Vector<java.lang.String>	readAndSplitFile(java.lang.String fileName) This function splits the file into a vector of Strings, each item in the vector representing one line.
static java.util.Vector<java.lang.String>	readAndSplitLine(java.io.BufferedReader br) This function splits the next line createTool from the specified BufferReader into a vector of Strings contained within the line.
static java.lang.String	readFile(java.io.BufferedReader br) Reads all the file pointed to by the given reader into the returned string.
static java.lang.String	readFile(java.lang.String filename) Reads the file specified by the given Filename and puts it into a string.
static boolean	rename(java.io.File src, java.io.File dest)
static java.util.Vector<java.lang.String>	splitLine(java.lang.String line) This function splits the line into a vector of Strings separated by spaces.
static java.util.Vector	splitPath(java.lang.String path) This function splits up the CLASSPATH and the TOOLBOXES environment variables into the various specified paths.
static void	writeToFile(java.lang.String name, java.lang.String contents) Write the specified String to the file
static void	writeToFile(java.lang.String name, java.lang.String contents, boolean append) Write the specified String to the file with option to append
static void	writeToFile(java.lang.String name, java.util.Vector<java.lang.String> contents) Write the specified StringVector to the file, writing each element on a separate line

Methods inherited from class java.lang.Object

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

Field Detail

ASCII

public static final int ASCII

See Also:

Constant Field Values

BINARY

public static final int BINARY

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

deleteFiles

public static void deleteFiles(java.io.File parent,
               boolean incParent)
                        throws java.io.FileNotFoundException

deletes files recursively. can optionally delete the parent file as well. So, if the parent file is not a directory, and incParent is false, then nothing will be deleted.

Parameters:

parent - file to delete. If this is a directory then any children are deleted.

incParent - boolean that determines if the parent file is also deleted.

Throws:

java.io.FileNotFoundException

formatThrowable

public static java.lang.String formatThrowable(java.lang.Throwable t)

rename

public static boolean rename(java.io.File src,
             java.io.File dest)

copyFilesRecursive

public static java.util.List<java.io.File> copyFilesRecursive(java.io.File src,
                                              java.io.File dest)
                                                       throws java.io.IOException

Copies files and directories recursively. The destination does not have to exist yet.

Parameters:

src - the source file to copy. Can be a file or a directory.

dest - the destination to copy to. Can be a file or directory.

Returns:

a List of the newly created Files

Throws:

java.io.FileNotFoundException - if src does not exist

java.io.IOException - if src is a directory and dest exists and is not a directory, or an IO error occurs.

deleteFile

public static void deleteFile(java.lang.String loc)

Deletes the file at the given file location. If the file is a directory then the directory must be empty for the operation to be successful.

isOnInternet

public static boolean isOnInternet(java.lang.String fileOrPath)

Determines whether the given path or file is an internet address or not

isDirectory

public static boolean isDirectory(java.lang.String loc)

Determines whether the file specified is a directory. Files specified as string could be internet paths or local paths. This function will determine which one it is.

isParent

public static boolean isParent(java.lang.String parent,
               java.lang.String child)

Checks whether the child is contained by the parent directory.

Parameters:

parent - String representing the parent directory

child - String representing the child file or directory

Returns:

False if parent is not a directory, or parent equals child, True if and only if child is contained in parent.

correctURL

public static java.lang.String correctURL(java.lang.String file)

Converts a URL address which may have machine dependant path separators contained within it to an appropraite URL address e.g. can have http://www.comp.com/\file\on\d\ for example which should be http://www.comp.com/file/on/d/

isDirectory

public static boolean isDirectory(java.net.URL loc)

Determines whether the internet location and file specified is in fact a directory. This is determined by checking whether there exists a

exists on the first line of the html file which is the typical thing included on the first line if a directory is given to a server

listInternetDirectory

public static java.util.Vector<java.lang.String> listInternetDirectory(java.net.URL loc)

Lists the filenames and directories within a URL if that URL is a directory

copyFile

public static boolean copyFile(java.lang.String loc1,
               java.lang.String loc2,
               int mode)

As copyFile except that it doesn't confirm on replacing a file.

See Also:

copyFile(java.lang.String, java.lang.String, int)

copyFile

public static boolean copyFile(java.lang.String loc1,
               java.lang.String loc2,
               int mode,
               boolean confirmOnReplace)

Copies the file from the first location to the second. If the second location exists then the user is prompted to ask if he/she wants to overwrite the exisiting file. They are given dates of the files also. The full Bill Gates effect!!!!!! The mode can be either ASCII or BINARY.

Returns:

false if the file could not be copied, true if successful

createWriter

public static java.io.PrintWriter createWriter(java.lang.String name)

creates a buffered writer for a specified local or networked text file. Just give the protocol and path if its a networked file e.g. :- http:///www.astro.cf.ac.uk/pub/Ian.Taylor/Triana/Help/Wave.html or the absolute file name if its a local file.

Parameters:

name - the name of the file you wish to make a writer for.

createWriter

public static java.io.PrintWriter createWriter(java.net.URL url)

Creates a buffered writer to a specific URL.

Parameters:

url - the name of the file you wish to make a writer for

createWriter

public static java.io.PrintWriter createWriter(java.lang.String name,
                               boolean append)

creates a buffered writer for a specified local file, with an option to append. Just give the absolute file name.

Parameters:

name - the name of the file you wish to make a writer for.

createReader

public static java.io.BufferedReader createReader(java.lang.String name)
                                           throws java.io.IOException

creates a buffered reader for a specified local or networked text file. Just give the protocol and path if its a networked file e.g. :- http:///www.astro.cf.ac.uk/pub/Ian.Taylor/Triana/Help/Wave.html or the absolute file name if its a local file.

Parameters:

name - the name of the file you wish to make a reader for.

Throws:

java.io.IOException

createReader

public static java.io.BufferedReader createReader(java.net.URL url)

creates a buffered reader for a URL

Parameters:

url - the name of the file you wish to make a reader for.

fileExists

public static boolean fileExists(java.lang.String name)

return true if the specified file (or Directory) exists either on a network or a local server. The function automatically detects where the file is.

Parameters:

name - the name of the file.

closeReader

public static void closeReader(java.io.BufferedReader br)

closes the given reader

Parameters:

br - the reader to close.

closeWriter

public static void closeWriter(java.io.PrintWriter pw)

closes the given writer

Parameters:

pw - the writer to close.

writeToFile

public static void writeToFile(java.lang.String name,
               java.lang.String contents)

Write the specified String to the file

writeToFile

public static void writeToFile(java.lang.String name,
               java.lang.String contents,
               boolean append)

Write the specified String to the file with option to append

writeToFile

public static void writeToFile(java.lang.String name,
               java.util.Vector<java.lang.String> contents)

Write the specified StringVector to the file, writing each element on a separate line

createInputStream

public static java.io.DataInputStream createInputStream(java.lang.String name)
                                                 throws java.io.IOException

Creates a reader for a specified local or networked binary file. Just give the protocol and path if its a networked file e.g. :- http:///www.astro.cf.ac.uk/pub/Ian.Taylor/Triana/Help/Wave.html or the absolute file name if its a local file.

Parameters:

name - the name of the file you wish to make a reader for.

Throws:

java.io.IOException

createOutputStream

public static java.io.DataOutputStream createOutputStream(java.lang.String name)

Creates an output stream for a specified local or networked binary file. Just give the protocol and path if its a networked file e.g. :- http:///www.astro.cf.ac.uk/Triana/data.bin or the absolute file name if its a local file.

Parameters:

name - the name of the file you wish to make an output stream for.

closeOutputStream

public static void closeOutputStream(java.io.DataOutputStream dos)

Closes the given output stream.

closeInputStream

public static void closeInputStream(java.io.DataInputStream di)

Closes the given input stream.

getAudioClip

public static java.applet.AudioClip getAudioClip(java.net.URL audioLoc)

Loads in a sound file from the specified internet location.

getAudioClip

public static java.applet.AudioClip getAudioClip(java.lang.String audioFile)

Loads in a sound file from the internet or local disk. It auto-detects what protocol it should use.

getSystemAudioClip

public static java.applet.AudioClip getSystemAudioClip(java.lang.String audioFile)

Loads in a Triana system sound file via the internet (if it is an applet) or local disk. It auto-detects what protocol it should use. It looks in the triana/system/sounds directory for the sound file called "audioFile"

playSystemAudio

public static void playSystemAudio(java.lang.String audioFile)

Plays a Triana system sound file by loading it across the internet (if Triana is an applet)or local disk. It auto-detects what protocol it should use. It looks in the %TRIANA%/system/sounds directory for the sound file called "audioFile"

getImage

public static java.awt.Image getImage(java.lang.String imageName)

Loads in an image from the internet or local disk. It auto-detects what protocol it should use.

This is legacy and only used by some Units - core Triana classes should use getSystemImage(java.lang.String)

getSystemImageIcon

public static javax.swing.ImageIcon getSystemImageIcon(java.lang.String imageName)

Loads in a triana system image icon from the internet or local disk. It auto-detects what protocol it should use and looks in the triana/system/icons directory for the image called "imageName"

getSystemImage

public static java.awt.Image getSystemImage(java.lang.String imageName)

Loads in a triana system image from the internet or local disk. It auto-detects what protocol it should use and looks in the triana/system/icons directory for the image called "imageName"

getFileNameNoSuffix

public static java.lang.String getFileNameNoSuffix(java.lang.String fullName)

Returns:

the file name without suffix or path details.

splitPath

public static java.util.Vector splitPath(java.lang.String path)

This function splits up the CLASSPATH and the TOOLBOXES environment variables into the various specified paths. A Vector is returned containing the paths found. We also take into account that paths can be internet address also by including an internet address in the following form in your environment variables :-

protocol://server/directory
for example
http://www.astro.cf.ac.uk/pub/Ian.Taylor/Triana/Release/classes

readAndSplitLine

public static java.util.Vector<java.lang.String> readAndSplitLine(java.io.BufferedReader br)

This function splits the next line createTool from the specified BufferReader into a vector of Strings contained within the line. Each string is split up if they are separated by a single white space. The function returns a StringVector which is basically, a Vector which only stores strings, so we don't have type-cast all the time.

nextNonEmptySplitLine

public static java.util.Vector<java.lang.String> nextNonEmptySplitLine(java.io.BufferedReader br)

Skips the empty lines in a file and returns the next non-empty line or null if the end of the file is reached. The line returned is a vector of string with one string representing each word or whatever in the file, like readAndSplitLine

See Also:

readAndSplitLine(java.io.BufferedReader)

nextNonEmptyLine

public static java.lang.String nextNonEmptyLine(java.io.BufferedReader br)
                                         throws java.io.IOException

Skips the empty lines in a file and returns the next non-empty line or null if the end of the file is reached.

Throws:

java.io.IOException

See Also:

readAndSplitLine(java.io.BufferedReader)

splitLine

public static java.util.Vector<java.lang.String> splitLine(java.lang.String line)

This function splits the line into a vector of Strings separated by spaces. Each string is split up if they are separated by a single white space. The function returns a StringVector which is basically, a Vector which only stores strings, so we don't have type-cast all the time.

readFile

public static java.lang.String readFile(java.io.BufferedReader br)

Reads all the file pointed to by the given reader into the returned string. This function also closes the file (since we have createTool it all!).

For example, to open, createTool all, and close a file you type :-

 String template = FileUtils.readFile(FileUtils.createReader(fileName));
 

readFile

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

Reads the file specified by the given Filename and puts it into a string. This uses DataInputStream to createTool the file fully and then create a string which is a lot faster than reading a line at a time. Use this function for speed.

readAndSplitFile

public static java.util.Vector<java.lang.String> readAndSplitFile(java.io.BufferedReader br)

This function splits the file into a vector of Strings, each item in the vector representing one line. Used for loading in the TrianaType file and useful for splitting up file into a vector of easily accessable lines. This function also closes the file (since we have createTool it all!)

readAndSplitFile

public static java.util.Vector<java.lang.String> readAndSplitFile(java.lang.String fileName)

This function splits the file into a vector of Strings, each item in the vector representing one line. Used for loading in the TrianaType file and useful for splitting up file into a vector of easily accessable lines. This function also closes the file (since we have createTool it all!)

convertToVirtualName

public static java.lang.String convertToVirtualName(java.lang.String fileName)

Convert the given fileName into a machine independant form by making use of the environment variables to set up relative paths etc. for example, instead of using /getApplicationDataDir/specta/ian/grodcl/dir/file.name we would use $TRIANA/dir/file.name so that we could convert the file to the relevant directory on any machine.

convertFromVirtualName

public static java.lang.String convertFromVirtualName(java.lang.String fileName)

Convert machine independant form to actual fileName

listFileNames

public static Listing listFileNames(java.lang.String searchdir,
                    java.lang.String searchFilter,
                    boolean recurseDirs)

Gets a Listing Object for the given directory, the given searchstring (i.e. a wildcard based matcher) and a flag indicating whether the FileList should recurse into other directories or not.

The searchFilter can be any unix style (or DOS style) search expression when using ls or dir. This can also be a file, directory or null. If its a file then this class can be used to determine whether the file exists or not (i.e. if fileFound() == 0 or exists() == false then the file does not exist. If searchFilter is a directory then the directory is listed (if it exists) and if it is set to null then the search is based on the first argument (i.e. the searchdir). This is useful for just lsiting the contents of the directory.

The searchdir can contain "./" or "../" (unix) or ".\" "..\" in dos.

listDirNames

public static Listing listDirNames(java.lang.String searchdir,
                   java.lang.String searchFilter,
                   boolean recurseDirs)

Gets a Listing Object for the given directory, the given searchstring (i.e. a wildcard based matcher) and a flag indicating whether the FileList should recurse into other directories or not.

The searchFilter can be any unix style (or DOS style) search expression when using ls or dir. This can also be a file, directory or null. If its a file then this class can be used to determine whether the file exists or not (i.e. if fileFound() == 0 or exists() == false then the file does not exist. If searchFilter is a directory then the directory is listed (if it exists) and if it is set to null then the search is based on the first argument (i.e. the searchdir). This is useful for just lsiting the contents of the directory.

The searchdir can contain "./" or "../" (unix) or ".\" "..\" in dos.

listAllFiles

public static Listing listAllFiles(java.lang.String searchdir,
                   java.lang.String searchFilter,
                   boolean recurseDirs)

Gets a Listing Object for the given directory, the given searchstring (i.e. a wildcard based matcher) and a flag indicating whether the FileList should recurse into other directories or not.

The searchFilter can be any unix style (or DOS style) search expression when using ls or dir. This can also be a file, directory or null. If its a file then this class can be used to determine whether the file exists or not (i.e. if fileFound() == 0 or exists() == false then the file does not exist. If searchFilter is a directory then the directory is listed (if it exists) and if it is set to null then the search is based on the first argument (i.e. the searchdir). This is useful for just lsiting the contents of the directory.

The searchdir can contain "./" or "../" (unix) or ".\" "..\" in dos.

absolutePath

public static java.lang.String absolutePath(java.lang.String path)

Returns:

the absolute path of the given directory i.e. the path may contain many ../'s or ./'s in its path. This works out the correct path

listDir

public static Listing listDir(java.lang.String dir,
              boolean recurse)

Finds all file names in the specified directory and in all directories lower down in the tree. This list includes directories also and is highly structured. It contains a Vector of File Object (representing file and directory) names and Vectors containing listings of other directories. These other such directories also have the same format.

listDir

public static java.lang.String[] listDir(java.lang.String dir)

returns a list of file names in the given directory or returns null if the directory is empty or if it does not exist.

listDir

public static Listing listDir(java.net.URL dir,
              boolean recurse)

Finds all file names in the specified directory and in all directories lower down in the tree. This list includes directories also and is highly structured. It contains a Vector of File Object (representing file and directory) names and Vectors containing listings of other directories. These other such directories also have the same format.

listEndsWith

public static java.io.File[] listEndsWith(java.lang.String baseDir,
                          java.lang.String endsWith)

listEndsWith

public static java.io.File[] listEndsWith(java.lang.String baseDir,
                          java.lang.String endsWith,
                          java.lang.String[] excludedir)

listEndsWith

public static java.io.File[] listEndsWith(java.lang.String baseDir,
                          java.lang.String[] endsWith,
                          java.lang.String[] excludedir)