net.java.html.lib.node.path

Class Exports

java.lang.Object

net.java.html.lib.Objs

net.java.html.lib.node.path.Exports

public final class Exports
extends Objs

Nested Class Summary

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Objs.Property<String>	delimiter
static Objs.Property<String>	sep

Fields inherited from class net.java.html.lib.Objs

prototype

Method Summary

Modifier and Type	Method and Description
static String	basename(String p) Return the last portion of a path.
static String	basename(String p, String ext) Return the last portion of a path.
static String	dirname(String p) Return the directory name of a path.
static String	extname(String p) Return the extension of the path, from the last '.' to end of string in the last portion of the path.
static String	format(ParsedPath pathObject) Returns a path string from an object - the opposite of parse().
static Boolean	isAbsolute(String path) Determines whether {path} is an absolute path.
static String	join(Object... paths) Join all arguments together and normalize the resulting path.
static String	join(String... paths) Join all arguments together and normalize the resulting path.
static String	normalize(String p) Normalize a string path, reducing '..' and '.' parts.
static ParsedPath	parse(String pathString) Returns an object from a path string - the opposite of format().
static String	relative(String from, String to) Solve the relative path from {from} to {to}.
static String	resolve(Object... pathSegments) The right-most parameter is considered {to}.

Methods inherited from class net.java.html.lib.Objs

$as, $as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

sep

public static Objs.Property<String> sep

delimiter

public static Objs.Property<String> delimiter

Method Detail

basename

public static String basename(String p,
                              String ext)

Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

Parameters:

p - the path to evaluate.

ext - optionally, an extension to remove from the result.

basename

public static String basename(String p)

Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

Parameters:

p - the path to evaluate.

ext - optionally, an extension to remove from the result.

dirname

public static String dirname(String p)

Return the directory name of a path. Similar to the Unix dirname command.

Parameters:

p - the path to evaluate.

extname

public static String extname(String p)

Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string

Parameters:

p - the path to evaluate.

format

public static String format(ParsedPath pathObject)

Returns a path string from an object - the opposite of parse().

Parameters:

pathString - path to evaluate.

isAbsolute

public static Boolean isAbsolute(String path)

Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

Parameters:

path - path to test.

join

public static String join(Object... paths)

Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

Parameters:

paths - string paths to join.

join

public static String join(String... paths)

Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

Parameters:

paths - string paths to join.

normalize

public static String normalize(String p)

Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

Parameters:

p - string path to normalize.

parse

public static ParsedPath parse(String pathString)

Returns an object from a path string - the opposite of format().

Parameters:

pathString - path to evaluate.

relative

public static String relative(String from,
                              String to)

Solve the relative path from {from} to {to}. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.

Parameters:

from -

to -

resolve

public static String resolve(Object... pathSegments)

The right-most parameter is considered {to}. Other parameters are considered an array of {from}. Starting from leftmost {from} paramter, resolves {to} to an absolute path. If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

Parameters:

pathSegments - string paths to join. Non-string arguments are ignored.