com.viaoa.util

Class OAFile

java.lang.Object

java.io.File

com.viaoa.util.OAFile

All Implemented Interfaces:

Serializable, Comparable<File>

public class OAFile
extends File

Subclass of java.io.File that includes extra functionality.

Note: All file names separators will automatically be converted to match the Operating System.

See Also:

OAString.convertFileName(java.lang.String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FS
static String	NL

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
OAFile(String fname)

Method Summary

Modifier and Type	Method and Description
static String	convertFileName(String fileName) Converts fileName path to correct system file.separator characters.
static String	convertFileName(String fileName, boolean bEndWithSlashChar) Converts fileName path to correct system file.separator characters.
static void	copy(File file, File fileTo)
static void	copy(String fileNameFrom, String fileNameTo) Copy a file to another file.
static boolean	copyResourceToFile(Class c, String resourceName, String fname) Copy a file from class/jar to file.
boolean	copyTo(OAFile fileTo) Copy this file to another file.
boolean	copyTo(String fileNameTo) Copy this file to another file.
static void	delTree(File f)
static String	getDirectoryName(String filePath)
static String	getExtension(File file)
static String	getExtension(String filePath)
static String	getFileName(String filePath)
void	mkdirsForFile() Create all directories for fileName.
static void	mkdirsForFile(File file)
static void	mkdirsForFile(String fileName) Create directories for fileName. Compared to the method in the File.class, "File.mkdirs()" which creates a directory using the full fileName, where fileName itself will end up being a directory.
static String[]	readResourceTextFile(Class c, String resourceName) Read the contents of a text file from a specific class location.
static String	readTextFile(Class c, String fname, int estimatedSize) Read the contents of a text file from a specific class location.
static String	readTextFile(File file, int estimatedSize)
static String	readTextFile(String fname, int estimatedSize)
static void	removeDir(File f)
void	renameTo(String fileName) Renames this file to another name.
static void	rmDir(File f) Remove directory and all children files.
static boolean	writeTextFile(File file, String data)
static boolean	writeTextFile(String fname, String data)

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FS

public static final String FS

NL

public static final String NL

Constructor Detail

OAFile

public OAFile(String fname)

Method Detail

copyTo

public boolean copyTo(String fileNameTo)

Copy this file to another file.

See Also:

copy(String,String)

copyTo

public boolean copyTo(OAFile fileTo)

Copy this file to another file.

See Also:

copy(String,String)

mkdirsForFile

public void mkdirsForFile()

Create all directories for fileName.

convertFileName

public static String convertFileName(String fileName)

Converts fileName path to correct system file.separator characters.

Returns:

new String with corrected file path characters.

convertFileName

public static String convertFileName(String fileName,
                                     boolean bEndWithSlashChar)

Converts fileName path to correct system file.separator characters.

Returns:

new String with corrected file path characters.

getFileName

public static String getFileName(String filePath)

getDirectoryName

public static String getDirectoryName(String filePath)

getExtension

public static String getExtension(File file)

getExtension

public static String getExtension(String filePath)

mkdirsForFile

public static void mkdirsForFile(String fileName)

Create directories for fileName.
Compared to the method in the File.class, "File.mkdirs()" which creates a directory using the full fileName, where fileName itself will end up being a directory. This method assumes that the fileName is for a file and will then create the directories needed so that the file can be saved.

mkdirsForFile

public static void mkdirsForFile(File file)

renameTo

public void renameTo(String fileName)

Renames this file to another name. This will create the required directories for the new file.

copy

public static void copy(String fileNameFrom,
                        String fileNameTo)
                 throws Exception

Copy a file to another file. This will create the required directories for the new file.

NOTE: if the fileNameTo already exists, it will be overwritten.

Throws:

Exception

copy

public static void copy(File file,
                        File fileTo)
                 throws Exception

Throws:

Exception

copyResourceToFile

public static boolean copyResourceToFile(Class c,
                                         String resourceName,
                                         String fname)
                                  throws Exception

Copy a file from class/jar to file.

Parameters:

c -

resourceName - class path name for file to read param fname file name to save as param estimatedSize

Returns:

true if successful, false if resource did not exist

Throws:

Exception

readResourceTextFile

public static String[] readResourceTextFile(Class c,
                                            String resourceName)
                                     throws Exception

Read the contents of a text file from a specific class location. This will read from a jar file. param fname '/' seperated file name, located from the class. If fname begins with '/' then the file will go to the root directory.

Throws:

Exception

readTextFile

public static String readTextFile(Class c,
                                  String fname,
                                  int estimatedSize)
                           throws Exception

Read the contents of a text file from a specific class location. This will read from a jar file.

Parameters:

fname - '/' seperated file name, located from the class. If fname begins with '/' then the file will go to the root directory.

Throws:

Exception

readTextFile

public static String readTextFile(File file,
                                  int estimatedSize)
                           throws Exception

Throws:

Exception

readTextFile

public static String readTextFile(String fname,
                                  int estimatedSize)
                           throws Exception

Throws:

Exception

writeTextFile

public static boolean writeTextFile(String fname,
                                    String data)
                             throws Exception

Throws:

Exception

writeTextFile

public static boolean writeTextFile(File file,
                                    String data)
                             throws Exception

Throws:

Exception

rmDir

public static void rmDir(File f)
                  throws IOException

Remove directory and all children files.

Throws:

IOException

removeDir

public static void removeDir(File f)
                      throws IOException

Throws:

IOException

delTree

public static void delTree(File f)
                    throws IOException

Throws:

IOException