Class PathTool
- Author:
- Pete Kazmier, Vincent Massol, Vincent Siveton
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic final String
calculateLink
(String link, String relativePath) Calculates the appropriate link given the preferred link and the relativePath of the document.static final String
getDirectoryComponent
(String filename) Determines the directory component of a filename.static final String
getRelativeFilePath
(String oldPath, String newPath) This method can calculate the relative path between two paths on a file system.static final String
getRelativePath
(String filename) Determines the relative path of a filename.static final String
getRelativePath
(String basedir, String filename) Determines the relative path of a filename from a base directory.static final String
getRelativeWebPath
(String oldPath, String newPath) This method can calculate the relative path between two paths on a web site.
-
Constructor Details
-
PathTool
public PathTool()
-
-
Method Details
-
getRelativePath
Determines the relative path of a filename from a base directory. This method is useful in building relative links within pages of a web site. It provides similar functionality to Anakia's
$relativePath
context variable. The arguments to this method may contain either forward or backward slashes as file separators. The relative path returned is formed using forward slashes as it is expected this path is to be used as a link in a web page (again mimicking Anakia's behavior).This method is thread-safe.
PathTool.getRelativePath( null, null ) = "" PathTool.getRelativePath( null, "/usr/local/java/bin" ) = "" PathTool.getRelativePath( "/usr/local/", null ) = "" PathTool.getRelativePath( "/usr/local/", "/usr/local/java/bin" ) = ".." PathTool.getRelativePath( "/usr/local/", "/usr/local/java/bin/java.sh" ) = "../.." PathTool.getRelativePath( "/usr/local/java/bin/java.sh", "/usr/local/" ) = ""
- Parameters:
basedir
- The base directory.filename
- The filename that is relative to the base directory.- Returns:
- The relative path of the filename from the base directory. This value is not terminated with a forward
slash. A zero-length string is returned if: the filename is not relative to the base directory,
basedir
is null or zero-length, orfilename
is null or zero-length.
-
getRelativePath
Determines the relative path of a filename. This method is useful in building relative links within pages of a web site. It provides similar functionality to Anakia's
$relativePath
context variable. The argument to this method may contain either forward or backward slashes as file separators. The relative path returned is formed using forward slashes as it is expected this path is to be used as a link in a web page (again mimicking Anakia's behavior).This method is thread-safe.
- Parameters:
filename
- The filename to be parsed.- Returns:
- The relative path of the filename. This value is not terminated with a forward slash. A zero-length
string is returned if:
filename
is null or zero-length. - See Also:
-
getDirectoryComponent
Determines the directory component of a filename. This is useful within DVSL templates when used in conjunction with the DVSL's
$context.getAppValue("infilename")
to get the current directory that is currently being processed.This method is thread-safe.
PathTool.getDirectoryComponent( null ) = "" PathTool.getDirectoryComponent( "/usr/local/java/bin" ) = "/usr/local/java" PathTool.getDirectoryComponent( "/usr/local/java/bin/" ) = "/usr/local/java/bin" PathTool.getDirectoryComponent( "/usr/local/java/bin/java.sh" ) = "/usr/local/java/bin"
- Parameters:
filename
- The filename to be parsed.- Returns:
- The directory portion of the
filename
. If the filename does not contain a directory component, "." is returned.
-
calculateLink
Calculates the appropriate link given the preferred link and the relativePath of the document.PathTool.calculateLink( "/index.html", "../.." ) = "../../index.html" PathTool.calculateLink( "http://plexus.codehaus.org/plexus-utils/index.html", "../.." ) = "http://plexus.codehaus.org/plexus-utils/index.html" PathTool.calculateLink( "/usr/local/java/bin/java.sh", "../.." ) = "../../usr/local/java/bin/java.sh" PathTool.calculateLink( "../index.html", "/usr/local/java/bin" ) = "/usr/local/java/bin/../index.html" PathTool.calculateLink( "../index.html", "http://plexus.codehaus.org/plexus-utils" ) = "http://plexus.codehaus.org/plexus-utils/../index.html"
- Parameters:
link
- main linkrelativePath
- relative- Returns:
- String
-
getRelativeWebPath
This method can calculate the relative path between two paths on a web site.PathTool.getRelativeWebPath( null, null ) = "" PathTool.getRelativeWebPath( null, "http://plexus.codehaus.org/" ) = "" PathTool.getRelativeWebPath( "http://plexus.codehaus.org/", null ) = "" PathTool.getRelativeWebPath( "http://plexus.codehaus.org/", "http://plexus.codehaus.org/plexus-utils/index.html" ) = "plexus-utils/index.html" PathTool.getRelativeWebPath( "http://plexus.codehaus.org/plexus-utils/index.html", "http://plexus.codehaus.org/" = "../../"
- Parameters:
oldPath
- main pathnewPath
- second path- Returns:
- a relative web path from
oldPath
.
-
getRelativeFilePath
This method can calculate the relative path between two paths on a file system.PathTool.getRelativeFilePath( null, null ) = "" PathTool.getRelativeFilePath( null, "/usr/local/java/bin" ) = "" PathTool.getRelativeFilePath( "/usr/local", null ) = "" PathTool.getRelativeFilePath( "/usr/local", "/usr/local/java/bin" ) = "java/bin" PathTool.getRelativeFilePath( "/usr/local", "/usr/local/java/bin/" ) = "java/bin" PathTool.getRelativeFilePath( "/usr/local/java/bin", "/usr/local/" ) = "../.." PathTool.getRelativeFilePath( "/usr/local/", "/usr/local/java/bin/java.sh" ) = "java/bin/java.sh" PathTool.getRelativeFilePath( "/usr/local/java/bin/java.sh", "/usr/local/" ) = "../../.." PathTool.getRelativeFilePath( "/usr/local/", "/bin" ) = "../../bin" PathTool.getRelativeFilePath( "/bin", "/usr/local/" ) = "../usr/local"
Note: On Windows based system, the/
character should be replaced by\
character.- Parameters:
oldPath
- main pathnewPath
- second path- Returns:
- a relative file path from
oldPath
.
-