org.unix4j.util

Class RelativePathBase

java.lang.Object

org.unix4j.util.RelativePathBase

public class RelativePathBase
extends Object

This class represents a base directory for relative paths. The getRelativePathFor(File) method returns a path string relative to the base directory passed to the constructor of this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RelativePathBase.Settings Settings used to construct relative paths.

Field Summary

Fields

Modifier and Type	Field and Description
static RelativePathBase.Settings	ALL_CHILDREN_WITH_DOT_PREFIX Alternative settings to construct relative paths similar to DEFAULT: "." represents the base directory, "./" is used as prefix of child paths and "../" for elements up to the common ancestor.
static RelativePathBase.Settings	CHILDREN_WITHOUT_PREFIX Alternative settings to construct relative paths without prefixes for children: "." represents the base directory, no prefix for child paths and "../" for elements up to the common ancestor.
static RelativePathBase.Settings	DEFAULT Default settings to construct relative paths: "." represents the base directory, "./" is used as prefix of child paths (but "" for direct children) and "../" for elements up to the common ancestor.

Constructor Summary

Constructors

Constructor and Description
RelativePathBase(File base) Constructor with base directory for relative paths using DEFAULT settings to construct relative paths.
RelativePathBase(File base, RelativePathBase.Settings settings) Constructor with base directory for relative paths using the specified settings to construct relative paths.
RelativePathBase(String base) Constructor with base directory for relative paths using DEFAULT settings to construct relative paths.
RelativePathBase(String base, RelativePathBase.Settings settings) Constructor with base directory for relative paths using the specified settings to construct relative paths.

Method Summary

Modifier and Type	Method and Description
File	getBase() Returns the base directory for relative paths, the directory that was passed to the constructor.
String	getRelativePathFor(File file) Returns the path of the given file relative to the base directory.
String	getRelativePathFor(String file) Returns the path of the given file relative to the base directory.
RelativePathBase.Settings	getSettings() Returns the settings used to construct relative paths.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final RelativePathBase.Settings DEFAULT

Default settings to construct relative paths: "." represents the base directory, "./" is used as prefix of child paths (but "" for direct children) and "../" for elements up to the common ancestor.

ALL_CHILDREN_WITH_DOT_PREFIX

public static final RelativePathBase.Settings ALL_CHILDREN_WITH_DOT_PREFIX

Alternative settings to construct relative paths similar to DEFAULT: "." represents the base directory, "./" is used as prefix of child paths and "../" for elements up to the common ancestor. As opposed to the DEFAULT settings, the "./" prefix is used for all child paths including direct children.

CHILDREN_WITHOUT_PREFIX

public static final RelativePathBase.Settings CHILDREN_WITHOUT_PREFIX

Alternative settings to construct relative paths without prefixes for children: "." represents the base directory, no prefix for child paths and "../" for elements up to the common ancestor.

Constructor Detail

RelativePathBase

public RelativePathBase(String base)

Constructor with base directory for relative paths using DEFAULT settings to construct relative paths.

Parameters:

base - the basis for relative paths returned by getRelativePathFor(File)

RelativePathBase

public RelativePathBase(File base)

Constructor with base directory for relative paths using DEFAULT settings to construct relative paths.

Parameters:

base - the basis for relative paths returned by getRelativePathFor(File)

RelativePathBase

public RelativePathBase(String base,
                        RelativePathBase.Settings settings)

Constructor with base directory for relative paths using the specified settings to construct relative paths.

Parameters:

base - the basis for relative paths returned by getRelativePathFor(File)

settings - the settings used to construct relative paths

RelativePathBase

public RelativePathBase(File base,
                        RelativePathBase.Settings settings)

Constructor with base directory for relative paths using the specified settings to construct relative paths.

Parameters:

base - the basis for relative paths returned by getRelativePathFor(File)

settings - the settings used to construct relative paths

Method Detail

getBase

public File getBase()

Returns the base directory for relative paths, the directory that was passed to the constructor.

getSettings

public RelativePathBase.Settings getSettings()

Returns the settings used to construct relative paths. Has been passed to the constructor unless DEFAULT settings are used.

Returns:

the settings used to construct relative paths

getRelativePathFor

public String getRelativePathFor(File file)

Returns the path of the given file relative to the base directory.

The relative path is evaluated as follows:

1. If base is the same as file, "." is returned
2. If base is the direct parent directory of file, the simple file name is returned
3. If base is a non-direct parent directory of file, the relative path from base to file is returned
4. If base is not parent directory of file, the relative path is the path from base to the common ancestor and then to file
5. If base is not parent directory of file and the only common ancestor of the two is the base directory, the absolute path of file is returned

Examples (same order as above):

1. ("/home/john", "/home/john") → "."
2. ("/home/john", "/home/john/notes.txt") → "notes.txt"
3. ("/home/john", "/home/john/documents/important") → "./documents/important"
4. ("/home/john", "/home/smith/public/holidays.pdf") → "../smith/public/holidays.pdf"
5. ("/home/john", "/var/tmp/test.out") → "/var/tmp/test.out"

Parameters:

file - the target file whose relative path is returned

Returns:

the path of file relative to the base directory

getRelativePathFor

public String getRelativePathFor(String file)

Returns the path of the given file relative to the base directory.

The relative path is evaluated as follows:

1. If base is the same as file, "." is returned
2. If base is the direct parent directory of file, the simple file name is returned
3. If base is a non-direct parent directory of file, the relative path from base to file is returned
4. If base is not parent directory of file, the relative path is the path from base to the common ancestor and then to file
5. If base is not parent directory of file and the only common ancestor of the two is the base directory, the absolute path of file is returned

Examples (same order as above):

1. ("/home/john", "/home/john") → "."
2. ("/home/john", "/home/john/notes.txt") → "notes.txt"
3. ("/home/john", "/home/john/documents/important") → "./documents/important"
4. ("/home/john", "/home/smith/public/holidays.pdf") → "../smith/public/holidays.pdf"
5. ("/home/john", "/var/tmp/test.out") → "/var/tmp/test.out"

Parameters:

file - the target file whose relative path is returned

Returns:

the path of file relative to the base directory