org.apache.maven.util
Class DVSLPathTool

java.lang.Object
  org.apache.maven.util.DVSLPathTool

public class DVSLPathTool

extends java.lang.Object

Path tool for use with the DVSL toolbox. This class contains static methods to assist in determining path-related information such as relative paths.

Version:

$Id: DVSLPathTool.java 517014 2007-03-11 21:15:50Z ltheussl $

Author:

Pete Kazmier, Vincent Massol

To Do:

move to org.apache.maven.util or make a jelly tag

Constructor Summary

DVSLPathTool()

Method Summary

static java.lang.String	calculateLink(java.lang.String link, java.lang.String relativePath) Calculates the appropriate link given the preferred link and the relativePath of the document
static java.lang.String	getDirectoryComponent(java.lang.String filename) Determines the directory component of a filename.
static java.lang.String	getRelativePath(java.lang.String filename) Determines the relative path of a filename.
static java.lang.String	getRelativePath(java.lang.String basedir, java.lang.String filename) Determines the relative path of a filename from a base directory.
(package private) static java.lang.String	uppercaseDrive(java.lang.String path) Cygwin prefers lowercase drive letters, but other parts of maven use uppercase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DVSLPathTool

public DVSLPathTool()

Method Detail

getRelativePath

public static final java.lang.String getRelativePath(java.lang.String basedir,
                                                     java.lang.String filename)

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.

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, or filename is null or zero-length.

getRelativePath

public static final java.lang.String getRelativePath(java.lang.String filename)

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.

getDirectoryComponent

public static final java.lang.String getDirectoryComponent(java.lang.String filename)

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.

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.

uppercaseDrive

static final java.lang.String uppercaseDrive(java.lang.String path)

Cygwin prefers lowercase drive letters, but other parts of maven use uppercase

Parameters:

path -

Returns:

String

calculateLink

public static final java.lang.String calculateLink(java.lang.String link,
                                                   java.lang.String relativePath)

Calculates the appropriate link given the preferred link and the relativePath of the document

Parameters:

link -

relativePath -

Returns:

String