org.unix4j.util

Interface RelativePathBase.Settings

Enclosing class:

RelativePathBase

public static interface RelativePathBase.Settings

Settings used to construct relative paths.

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	appendPathForBaseDir(java.lang.StringBuilder result, java.io.File baseDir) Appends the path for a file that equals the base directory.
java.lang.StringBuilder	appendPrefixForChildren(java.lang.StringBuilder result, java.io.File baseDir, boolean directChildOfBase) Appends the path prefix for children of the base directory.
java.lang.StringBuilder	appendPrefixToCommonAncestor(java.lang.StringBuilder result, java.io.File baseDir, int levelsToCommonAncestor) Appends the path prefix from the base directory to the common ancestor of base directory and target file.

Method Detail

appendPathForBaseDir

java.lang.StringBuilder appendPathForBaseDir(java.lang.StringBuilder result,
                                             java.io.File baseDir)

Appends the path for a file that equals the base directory. Some settings may append "." or "./" and others the base directory name.

Parameters:

result - the string builder with the result path

baseDir - the base directory, here also the relative path target

Returns:

the result instance for chained invocations

appendPrefixForChildren

java.lang.StringBuilder appendPrefixForChildren(java.lang.StringBuilder result,
                                                java.io.File baseDir,
                                                boolean directChildOfBase)

Appends the path prefix for children of the base directory. Most settings add "./" as prefix, others maybe nothing and some add nothing for direct children but "./" for all other child paths.

Parameters:

result - the string builder with the result path

baseDir - the base directory, here a parent directory of the relative path target

Returns:

the result instance for chained invocations

appendPrefixToCommonAncestor

java.lang.StringBuilder appendPrefixToCommonAncestor(java.lang.StringBuilder result,
                                                     java.io.File baseDir,
                                                     int levelsToCommonAncestor)

Appends the path prefix from the base directory to the common ancestor of base directory and target file. Most settings add one "../" element for every directory up to the common ancestor.

Parameters:

result - the string builder with the result path

baseDir - the base directory, here a directory which has a common ancestor with the relative path target

Returns:

the result instance for chained invocations