ljbo82.util

Class Path

java.lang.Object

java.io.File

ljbo82.util.Path

All Implemented Interfaces:

Serializable, Comparable<File>

public class Path
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	Path.PathAccessException

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	copy(Path destinationDir, boolean replaceExisting) Copies path contents.
boolean	delete()
void	delete(boolean forceDirDelete) Deletes the pointed location.
Path	getAbsoluteFile()
Path	getCanonicalFile()
InputStream	getInputStream()
String	getMd5Checksum()
String	getMd5Checksum(int bufferSize)
static Path	getOrCreateDirectory(String dirPath) Gets given directory.
static Path	getOrCreateParentDir(String filePath) Considers given path as pointing to a file and return parent directory.
Path	getParentFile()
String	getRelativeTo(Path other)
String	getStringContents()
Path[]	listFiles()
Path[]	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

Path

public Path(String path)

Path

public Path(String parentPath,
            String childPath)

Path

public Path(Path parent,
            String childPath)

Path

public Path(File coreFile)

Path

public Path(File parent,
            String childPath)

Method Detail

getOrCreateDirectory

public static Path getOrCreateDirectory(String dirPath)
                                 throws Path.PathAccessException

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

Parameters:

dirPath - directory path

Returns:

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

Throws:

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

getOrCreateParentDir

public static Path getOrCreateParentDir(String filePath)
                                 throws Path.PathAccessException

Considers given path as pointing to a file and return parent directory. If returned directory does not exist, creates it.

Parameters:

filePath - path pointing to a file.

Returns:

Path pointing to parent directory. If returned directory does not exist it will be created (the entire directory hierarchy will be created if required).

Throws:

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

listFiles

public Path[] listFiles()

Overrides:

listFiles in class File

listFiles

public Path[] listFiles(FilenameFilter filter)

Overrides:

listFiles in class File

getParentFile

public Path getParentFile()

Overrides:

getParentFile in class File

getAbsoluteFile

public Path getAbsoluteFile()

Overrides:

getAbsoluteFile in class File

getCanonicalFile

public Path getCanonicalFile()
                      throws IOException

Overrides:

getCanonicalFile in class File

Throws:

IOException

getRelativeTo

public String getRelativeTo(Path other)

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getStringContents

public String getStringContents()
                         throws IOException

Throws:

IOException

getMd5Checksum

public String getMd5Checksum(int bufferSize)
                      throws Path.PathAccessException

Throws:

Path.PathAccessException

getMd5Checksum

public final String getMd5Checksum()
                            throws Path.PathAccessException

Throws:

Path.PathAccessException

delete

public void delete(boolean forceDirDelete)
            throws Path.PathAccessException

Deletes the pointed location.

Parameters:

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

Throws:

Path.PathAccessException - if given file does not exist or could not be deleted.

delete

public final boolean delete()
                     throws Path.PathAccessException

Overrides:

delete in class File

Throws:

Path.PathAccessException

copy

public void copy(Path destinationDir,
                 boolean replaceExisting)
          throws Path.PathAccessException

Copies path contents. 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:

Path.PathAccessException - if an error happened during the operation.