ljbo82.util

Class UniversalFile

java.lang.Object

java.io.File

ljbo82.util.UniversalFile

All Implemented Interfaces:

Serializable, Comparable<File>

public class UniversalFile
extends File

Represents a universal file.

Author:

Leandro Oliveira (ljbo.82@gmail.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniversalFile.FileAccessException

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
UniversalFile(File coreFile)
UniversalFile(File parent, String childPath)
UniversalFile(String path)
UniversalFile(String parentPath, String childPath)
UniversalFile(UniversalFile parent, String childPath)

Method Summary

Modifier and Type	Method and Description
void	copy(UniversalFile destinationDir, boolean replaceExisting) Copies this file.
boolean	delete()
void	delete(boolean forceDirDelete) Deletes this file.
UniversalFile	getAbsoluteFile()
UniversalFile	getCanonicalFile()
String	getContentString()
static UniversalFile[]	getFiles(String... paths)
InputStream	getInputStream()
String	getMd5Checksum()
String	getMd5Checksum(int bufferSize)
static UniversalFile	getOrCreateDirectory(File dir) Gets given directory.
static UniversalFile	getOrCreateDirectory(String dirPath) Convenience method.
UniversalFile	getParentFile()
String	getRelativeTo(UniversalFile other)
UniversalFile[]	listFiles()
UniversalFile[]	listFiles(FilenameFilter filter)

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, deleteOnExit, equals, exists, getAbsolutePath, getCanonicalPath, getFreeSpace, getName, getParent, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, 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

Constructor Detail

UniversalFile

public UniversalFile(String path)

UniversalFile

public UniversalFile(String parentPath,
                     String childPath)

UniversalFile

public UniversalFile(UniversalFile parent,
                     String childPath)

UniversalFile

public UniversalFile(File coreFile)

UniversalFile

public UniversalFile(File parent,
                     String childPath)

Method Detail

getFiles

public static UniversalFile[] getFiles(String... paths)

getOrCreateDirectory

public static UniversalFile getOrCreateDirectory(File dir)
                                          throws UniversalFile.FileAccessException

Gets given directory. If it does not exists, create entire hierarchy.

Parameters:

dir - directory

Returns:

File pointing to given directory. If directory hierarchy does not exist, they will be created.

Throws:

UniversalFile.FileAccessException - if an error happened during the process hierarchy does not exist and it was not possible to create it.

getOrCreateDirectory

public static UniversalFile getOrCreateDirectory(String dirPath)
                                          throws UniversalFile.FileAccessException

Convenience method.

Throws:

UniversalFile.FileAccessException

listFiles

public UniversalFile[] listFiles()

Overrides:

listFiles in class File

listFiles

public UniversalFile[] listFiles(FilenameFilter filter)

Overrides:

listFiles in class File

getParentFile

public UniversalFile getParentFile()

Overrides:

getParentFile in class File

getAbsoluteFile

public UniversalFile getAbsoluteFile()

Overrides:

getAbsoluteFile in class File

getCanonicalFile

public UniversalFile getCanonicalFile()
                               throws IOException

Overrides:

getCanonicalFile in class File

Throws:

IOException

getRelativeTo

public String getRelativeTo(UniversalFile other)

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getContentString

public String getContentString()
                        throws IOException

Throws:

IOException

getMd5Checksum

public String getMd5Checksum(int bufferSize)
                      throws UniversalFile.FileAccessException

Throws:

UniversalFile.FileAccessException

getMd5Checksum

public final String getMd5Checksum()
                            throws UniversalFile.FileAccessException

Throws:

UniversalFile.FileAccessException

delete

public void delete(boolean forceDirDelete)
            throws UniversalFile.FileAccessException

Deletes this file. If this file is a folder, delete its contents also.

Parameters:

forceDirDelete - force directory exclusion even if it contains files. USE IT WITH EXTREME CAREFUL !!!

Throws:

UniversalFile.FileAccessException - if given file does not exist or could not be deleted.

delete

public final boolean delete()
                     throws UniversalFile.FileAccessException

Overrides:

delete in class File

Throws:

UniversalFile.FileAccessException

copy

public void copy(UniversalFile destinationDir,
                 boolean replaceExisting)
          throws UniversalFile.FileAccessException

Copies this file. If it is directory, its contents will be copied too.

Parameters:

destinationDir - destination directory (will be created if it does not exist).

replaceExisting - defines if existing items shall be replaced.

Throws:

UniversalFile.FileAccessException - if an error happened during the operation.