net.sf.jfilesync.util
Interface TPathControlInterface

All Known Implementing Classes:
TPathControlBase, TPathUnix, TPathWindows

public interface TPathControlInterface


Method Summary
 java.lang.String appendDirectory(java.lang.String absolutePath, java.lang.String path)
           
 java.lang.String basename(java.lang.String path)
          returns the last object in a path like /a/b/c The object <> can be a filename or a name of a directory.
 java.lang.String basepath(java.lang.String rootdir, java.lang.String path, java.lang.String basename)
          returns b if the root dir is /a and path is /a/b/c and basename c
 java.lang.String getFileSeparator()
           
 java.lang.String getNetPath(java.lang.String path)
           
 java.lang.String getPathLevelUp(java.lang.String path)
           
 java.lang.String getPrintablePath(java.lang.String currentPath)
           
 java.lang.String getRoot(java.lang.String path)
          returns the current root of a given path
 boolean isRoot(java.lang.String path)
           
 java.lang.String netAppendDirectory(java.lang.String absolutePath, java.lang.String path)
           
 java.lang.String netPlainpath(java.lang.String root, java.lang.String path)
          the same functionality as plain path but for network protocols like FTP, SFTP where the folder root is "/"
 java.lang.String normalize(java.lang.String path)
          returns a valid path for a given system, if the path exists is not checked
 java.lang.String plainpath(java.lang.String root, java.lang.String path)
          root = /a path = /a/b/c returns b/c there will be no file separator at the start of the string
 boolean startsWithRoot(java.lang.String path)
           
 java.lang.String trimPathString(java.lang.String path)
           
 

Method Detail

isRoot

boolean isRoot(java.lang.String path)

getPathLevelUp

java.lang.String getPathLevelUp(java.lang.String path)

trimPathString

java.lang.String trimPathString(java.lang.String path)

appendDirectory

java.lang.String appendDirectory(java.lang.String absolutePath,
                                 java.lang.String path)

getNetPath

java.lang.String getNetPath(java.lang.String path)

netAppendDirectory

java.lang.String netAppendDirectory(java.lang.String absolutePath,
                                    java.lang.String path)

startsWithRoot

boolean startsWithRoot(java.lang.String path)

basename

java.lang.String basename(java.lang.String path)
returns the last object in a path like /a/b/c The object <> can be a filename or a name of a directory.

Parameters:
path -
Returns:
from /a/b/c(/) -> c

basepath

java.lang.String basepath(java.lang.String rootdir,
                          java.lang.String path,
                          java.lang.String basename)
returns b if the root dir is /a and path is /a/b/c and basename c

Parameters:
rootdir -
path -
basename -
Returns:
basepath

plainpath

java.lang.String plainpath(java.lang.String root,
                           java.lang.String path)
root = /a path = /a/b/c returns b/c there will be no file separator at the start of the string

Parameters:
root -
path -
Returns:
path without string that was declared to be root

netPlainpath

java.lang.String netPlainpath(java.lang.String root,
                              java.lang.String path)
the same functionality as plain path but for network protocols like FTP, SFTP where the folder root is "/"

Parameters:
root -
path -
Returns:
path without string that was passed to be the root

getRoot

java.lang.String getRoot(java.lang.String path)
returns the current root of a given path

Parameters:
path -
Returns:
the root of path or an empty string if path does not have a root

normalize

java.lang.String normalize(java.lang.String path)
returns a valid path for a given system, if the path exists is not checked


getFileSeparator

java.lang.String getFileSeparator()

getPrintablePath

java.lang.String getPrintablePath(java.lang.String currentPath)
Parameters:
currentPath -
Returns:
a path that can be printed on the current platform e.g. on Windows we need to substitute \ with \\