ecologylab.io
Class Files

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.io.Files

public class Files
extends Debug

A set of lovely convenience methods for doing operations on local files.

Field Summary

static int	ASP
static int	CSS
static int	EXE
java.io.BufferedReader	fileReader
java.io.BufferedWriter	fileWriter
static int	HTML
static java.lang.String	indent
java.io.File	inFile
static int	JAVA
static int	JAVASCRIPT
static int	NONE
java.io.File	outFile
static char	sep
static int	UNKNOWN

Constructor Summary

Files()

Files(java.lang.String inFileName)

Method Summary

static void	clearDir(java.io.File dir) removes all the files in a given directory
void	close()
boolean	closeReader()
static boolean	closeReader(java.io.BufferedReader reader)
boolean	closeWriter()
static boolean	closeWriter(java.io.BufferedWriter writer)
static boolean	contains(java.io.File f, java.lang.String s)
static boolean	contains(java.lang.String fileName, java.lang.String s)
static boolean	copy(java.io.File from, java.io.File to)
static void	copyFile(java.io.File srcFile, java.io.File dstFile) Copy a file -- binary or character data.
static void	copyFiles(java.io.File srcDir, java.io.File dstDir, java.lang.String fileType) copies all the files of a particular type from the src dir to the dest dir
static void	copyTraceFile(java.io.File outputFile)
static boolean	deleteDirectory(java.io.File targetDir) Recursively delete a directory on the file system.
static int	deriveLang(java.lang.String fName)
static boolean	flush(java.io.BufferedWriter writer)
static java.lang.String	getBeforeExtension(java.io.File file)
static java.lang.String	getBeforeExtension(java.lang.String fName)
java.lang.String	getDir(java.lang.String fullPath)
static java.lang.String	getExtension(java.io.File file)
static java.lang.String	getExtension(java.lang.String fName)
static java.lang.String	getTempFileName(java.lang.String name)
static java.io.File[]	getXMLFiles(java.io.File directory) Get the XML files in the directory.
static java.io.File[]	getXMLFiles(java.lang.String directoryPath) Get the XML files in the directory.
static boolean	insertFile(java.io.BufferedWriter writer, java.lang.String fileToInsert)
boolean	insertFile(java.lang.String fileToInsert)
static boolean	isDir(java.io.File file)
static void	main(java.lang.String[] s)
static void	main2(java.lang.String[] args)
static boolean	makePath(java.io.File oFile) Make any directories necesary for the file to be written.
static java.io.File	newFile(java.io.File context, java.lang.String inFileName) Create a new File object.
static java.io.File	newFile(java.lang.String inFileName) Create a new File object.
static java.io.File	newFile(java.lang.String contextName, java.lang.String inFileName) Create a new File object.
static java.io.FileInputStream	openInStream(java.io.File inFile)
static java.io.BufferedOutputStream	openOutStream(java.io.File oFile)
boolean	openRead(java.io.File inputFile)
boolean	openRead(java.lang.String inFileName)
boolean	openReader()
static java.io.BufferedReader	openReader(java.io.File file)
static java.io.BufferedReader	openReader(java.io.InputStream inStream)
static java.io.BufferedReader	openReader(java.io.InputStreamReader inputStreamReader)
static java.io.BufferedReader	openReader(java.lang.String fileName)
static java.io.BufferedReader	openReader(java.net.URL url)
static java.io.InputStream	openStream(java.net.URL url)
static java.io.BufferedReader	openWebReader(java.lang.String webAddr)
boolean	openWrite(java.io.File oFile)
boolean	openWrite(java.io.File outDir, java.lang.String outFileName)
boolean	openWrite(java.lang.String outFileName)
static java.io.BufferedWriter	openWriter(java.io.File oFile)
static java.io.BufferedWriter	openWriter(java.io.File oFile, boolean append)
static java.io.BufferedWriter	openWriter(java.io.File oFile, int debugLevel)
static java.io.BufferedWriter	openWriter(java.io.File oFile, int debugLevel, boolean append)
static java.io.BufferedWriter	openWriter(java.lang.String oFileName)
static java.io.BufferedWriter	openWriter(java.lang.String oFileName, boolean append)
java.lang.String	readLine()
static java.lang.String	readLine(java.io.BufferedReader reader)
static java.lang.String	relativePath(java.io.File parent, java.io.File child)
static java.lang.String	relativePath(java.io.File parent, java.lang.String childPath)
static java.lang.String	relativePath(java.lang.String parentPath, java.lang.String childPath)
static java.io.File	removeExtension(java.io.File f)
static java.io.File	removeExtension(java.lang.String path)
void	rename(java.lang.String finalName)
void	setInFile(java.lang.String inFileName)
static java.lang.String	unix(java.io.File f)
static java.lang.String	unix(java.lang.String s)
static boolean	write(java.io.BufferedWriter writer, java.lang.String toWrite)
boolean	write(java.lang.String toWrite)
static java.lang.String	writeErrorMsg(java.lang.Throwable e, java.io.File f)
static java.lang.String	writeErrorMsg(java.lang.Throwable e, java.lang.Object o)
static java.lang.String	writeErrorMsg(java.lang.Throwable e, java.lang.String path)
static boolean	writeLine(java.io.BufferedWriter writer, java.lang.String toWrite)
boolean	writeLine(java.lang.String toWrite)

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final int NONE

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

HTML

public static final int HTML

See Also:

Constant Field Values

JAVA

public static final int JAVA

See Also:

Constant Field Values

JAVASCRIPT

public static final int JAVASCRIPT

See Also:

Constant Field Values

ASP

public static final int ASP

See Also:

Constant Field Values

CSS

public static final int CSS

See Also:

Constant Field Values

EXE

public static final int EXE

See Also:

Constant Field Values

outFile

public java.io.File outFile

inFile

public java.io.File inFile

fileReader

public java.io.BufferedReader fileReader

fileWriter

public java.io.BufferedWriter fileWriter

sep

public static final char sep

indent

public static final java.lang.String indent

See Also:

Constant Field Values

Constructor Detail

Files

public Files()

Files

public Files(java.lang.String inFileName)

Method Detail

setInFile

public void setInFile(java.lang.String inFileName)

newFile

public static java.io.File newFile(java.lang.String inFileName)

Create a new File object. More robust than just calling the File constructor, cause it converts all slashes to the direction native for the platform.

newFile

public static java.io.File newFile(java.lang.String contextName,
                                   java.lang.String inFileName)

Create a new File object. More robust than just calling the File constructor, cause it converts all slashes to the direction native for the platform.

newFile

public static java.io.File newFile(java.io.File context,
                                   java.lang.String inFileName)

Create a new File object. More robust than just calling the File constructor, cause it converts all slashes to the direction native for the platform.

close

public void close()

closeReader

public boolean closeReader()

closeReader

public static boolean closeReader(java.io.BufferedReader reader)

closeWriter

public boolean closeWriter()

closeWriter

public static boolean closeWriter(java.io.BufferedWriter writer)

openReader

public static java.io.BufferedReader openReader(java.lang.String fileName)

openWebReader

public static java.io.BufferedReader openWebReader(java.lang.String webAddr)

openReader

public static java.io.BufferedReader openReader(java.io.File file)

openStream

public static java.io.InputStream openStream(java.net.URL url)

openReader

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

openReader

public static java.io.BufferedReader openReader(java.io.InputStream inStream)

openReader

public static java.io.BufferedReader openReader(java.io.InputStreamReader inputStreamReader)

openRead

public boolean openRead(java.io.File inputFile)

openRead

public boolean openRead(java.lang.String inFileName)

getTempFileName

public static java.lang.String getTempFileName(java.lang.String name)

openReader

public boolean openReader()

getDir

public java.lang.String getDir(java.lang.String fullPath)

openWrite

public boolean openWrite(java.lang.String outFileName)

openWrite

public boolean openWrite(java.io.File outDir,
                         java.lang.String outFileName)

openWrite

public boolean openWrite(java.io.File oFile)

openWriter

public static java.io.BufferedWriter openWriter(java.lang.String oFileName)

openWriter

public static java.io.BufferedWriter openWriter(java.lang.String oFileName,
                                                boolean append)

openWriter

public static java.io.BufferedWriter openWriter(java.io.File oFile,
                                                boolean append)

openWriter

public static java.io.BufferedWriter openWriter(java.io.File oFile)

makePath

public static boolean makePath(java.io.File oFile)

Make any directories necesary for the file to be written.

openWriter

public static java.io.BufferedWriter openWriter(java.io.File oFile,
                                                int debugLevel)

openWriter

public static java.io.BufferedWriter openWriter(java.io.File oFile,
                                                int debugLevel,
                                                boolean append)

openInStream

public static java.io.FileInputStream openInStream(java.io.File inFile)

openOutStream

public static java.io.BufferedOutputStream openOutStream(java.io.File oFile)

readLine

public java.lang.String readLine()

readLine

public static java.lang.String readLine(java.io.BufferedReader reader)

write

public boolean write(java.lang.String toWrite)

write

public static boolean write(java.io.BufferedWriter writer,
                            java.lang.String toWrite)

writeLine

public boolean writeLine(java.lang.String toWrite)

writeLine

public static boolean writeLine(java.io.BufferedWriter writer,
                                java.lang.String toWrite)

flush

public static boolean flush(java.io.BufferedWriter writer)

rename

public void rename(java.lang.String finalName)

insertFile

public boolean insertFile(java.lang.String fileToInsert)

copyTraceFile

public static void copyTraceFile(java.io.File outputFile)

insertFile

public static boolean insertFile(java.io.BufferedWriter writer,
                                 java.lang.String fileToInsert)

isDir

public static boolean isDir(java.io.File file)

copy

public static boolean copy(java.io.File from,
                           java.io.File to)

relativePath

public static java.lang.String relativePath(java.io.File parent,
                                            java.io.File child)

relativePath

public static java.lang.String relativePath(java.io.File parent,
                                            java.lang.String childPath)

relativePath

public static java.lang.String relativePath(java.lang.String parentPath,
                                            java.lang.String childPath)

getBeforeExtension

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

getBeforeExtension

public static java.lang.String getBeforeExtension(java.lang.String fName)

getExtension

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

getExtension

public static java.lang.String getExtension(java.lang.String fName)

deriveLang

public static int deriveLang(java.lang.String fName)

unix

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

unix

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

contains

public static boolean contains(java.lang.String fileName,
                               java.lang.String s)

contains

public static boolean contains(java.io.File f,
                               java.lang.String s)

removeExtension

public static java.io.File removeExtension(java.io.File f)

removeExtension

public static java.io.File removeExtension(java.lang.String path)

main

public static void main(java.lang.String[] s)

main2

public static void main2(java.lang.String[] args)
                  throws java.lang.Exception

Throws:

java.lang.Exception

writeErrorMsg

public static java.lang.String writeErrorMsg(java.lang.Throwable e,
                                             java.lang.Object o)

writeErrorMsg

public static java.lang.String writeErrorMsg(java.lang.Throwable e,
                                             java.io.File f)

writeErrorMsg

public static java.lang.String writeErrorMsg(java.lang.Throwable e,
                                             java.lang.String path)

clearDir

public static void clearDir(java.io.File dir)

removes all the files in a given directory

Parameters:

dir - the dir to be cleared

copyFiles

public static void copyFiles(java.io.File srcDir,
                             java.io.File dstDir,
                             java.lang.String fileType)

copies all the files of a particular type from the src dir to the dest dir

Parameters:

srcDir - source dir

dstDir - destination dir

fileType - type of the file, for example jpg for jpeg files if fileType is null, all the files are copied

copyFile

public static void copyFile(java.io.File srcFile,
                            java.io.File dstFile)

Copy a file -- binary or character data.

Parameters:

srcFile -

dstFile -

getXMLFiles

public static java.io.File[] getXMLFiles(java.lang.String directoryPath)

Get the XML files in the directory.

Parameters:

directoryPath - The file system parth for the directory.

Returns:

Array of File objects that constitute an ls *.xml for the directory.

getXMLFiles

public static java.io.File[] getXMLFiles(java.io.File directory)

Get the XML files in the directory.

Parameters:

directory - File object for the directory

Returns:

Array of File objects that constitute an ls *.xml for the directory.

deleteDirectory

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

Recursively delete a directory on the file system. We must recursively delete it since java requires that the directory be empty before deletion.

Parameters:

targetDir - The target directory to delete.

Returns:

true if successful, false otherwise.