StringPaths (LibJ Util 0.8.1 API)

java.lang.Object
- org.libj.util.StringPaths

```
public final class StringPaths
extends Object
```
Utility functions that perform a variety of operations on String objects representing either system paths (UNIX or Windows), or file URL paths (resembling file:/...).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`canonicalize(String path)` Returns the canonical form of the specified path, where `".."` and `"."` path names are dereferenced, and redundant `'/'` (or `'\'` for Windows) path separators are removed.
`static StringBuilder`	`canonicalize(StringBuilder path)` Returns the canonical form of the specified path, where `".."` and `"."` path names are dereferenced, and redundant `'/'` path separators are removed.
`static String`	`getCanonicalParent(String path)` Returns the canonical pathname of the parent of `path`, or `null` if `path` does not name a parent directory.
`static String`	`getName(String path)` Returns the name of the file or directory denoted by the specified pathname.
`static String`	`getParent(String path)` Returns the pathname of the parent of `path`, or `null` if `path` does not name a parent directory.
`static String`	`getProtocol(String path)` Returns the protocol section of the specified path, or `null` if a protocol section does not exist.
`static String`	`getShortName(String path)` Returns the short name of the file or directory denoted by the specified pathname.
`static boolean`	`isAbsolute(String path)` Tests whether the specified string represents an absolute path, either system or public.
`static boolean`	`isAbsoluteLocal(String path)` Tests whether the specified string represents an absolute local file path.
`static boolean`	`isAbsoluteLocalUnix(String path)` Tests whether the specified string represents an absolute UNIX file path.
`static boolean`	`isAbsoluteLocalURL(String path)` Tests whether the specified string is an URL that represents an absolute local file path.
`static boolean`	`isAbsoluteLocalWindows(String path)` Tests whether the specified string represents an absolute Windows file path.
`static boolean`	`isAbsolutePublicId(String path)` Tests whether the specified string represents an absolute public identifier.
`static boolean`	`isAbsoluteSystemId(String path)` Tests whether the specified string represents an absolute system identifier.
`static String`	`newPath(String parent, String child)` Creates a path string from a parent pathname string and a child pathname string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isAbsoluteLocalURL
```
public static boolean isAbsoluteLocalURL(String path)
```
    Tests whether the specified string is an URL that represents an absolute local file path.
    For a string to be considered an absolute local URL, it must:
    1. Be a valid URL.
    2. Specify the "file" protocol.
    3. Specify a host that is either empty or "localhost".
    Parameters:
    
    path - The path to test.
    
    Returns:
    
    true if the specified string is an URL that represents an absolute local file path, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsoluteLocalUnix
```
public static boolean isAbsoluteLocalUnix(String path)
```
    Tests whether the specified string represents an absolute UNIX file path.
    For a string to be considered an absolute UNIX file path, it must:
    1. Start with a leading '/' character.
    2. Not contain any '\0' characters.
    Parameters:
    
    path - The path to test.
    
    Returns:
    
    true if the specified string represents an absolute UNIX file path, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsoluteLocalWindows
```
public static boolean isAbsoluteLocalWindows(String path)
```
    Tests whether the specified string represents an absolute Windows file path.
    A valid Windows file path matches the following patterns:
    1. Drive path:
      c:\folder\myfile.txt
    2. UNC path (ip):
      \\123.123.123.123\share\folder\myfile.txt
    3. UNC path (named):
      \\server\share\folder\myfile.txt
    Parameters:
    
    path - The path to test.
    
    Returns:
    
    true if the specified string represents an absolute Windows file path, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsoluteLocal
```
public static boolean isAbsoluteLocal(String path)
```
    Tests whether the specified string represents an absolute local file path.
    For a string to be considered an absolute local file path, it must:
    1. Match a local file URL: isAbsoluteLocalURL(String)
    2. Match a Windows path: isAbsoluteLocalWindows(String)
    3. Match a UNIX path: isAbsoluteLocalUnix(String)
    Parameters:
    
    path - The path to test.
    
    Returns:
    
    true if the specified string represents an absolute local file path, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsoluteSystemId
```
public static boolean isAbsoluteSystemId(String path)
```
    Tests whether the specified string represents an absolute system identifier.
    Note: This method does not perform strict path validation, but merely inspects its prefix to match known absolute path patterns.
    This method performs the following tests to detect whether the specified string is an absolute path:
    1. If the string starts with '/' (UNIX paths).
    2. If the string starts with "?:\", where ? is a letter, case insensitive (Windows paths).
    Parameters:
    
    path - The string to test.
    
    Returns:
    
    true if the specified string represents an absolute system identifier, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsolutePublicId
```
public static boolean isAbsolutePublicId(String path)
```
    Tests whether the specified string represents an absolute public identifier.
    Note: This method does not perform strict path validation, but merely inspects its prefix to match known absolute path patterns.
    This method performs the following tests to detect whether the specified string is an absolute path:
    1. If the string starts with "<protocol>://", where <protocol> is any string matching [a-zA-Z0-9]+.
    Parameters:
    
    path - The string to test.
    
    Returns:
    
    true if the specified string represents an absolute public identifier, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - isAbsolute
```
public static boolean isAbsolute(String path)
```
    Tests whether the specified string represents an absolute path, either system or public.
    Note: This method does not perform strict path validation, but merely inspects its prefix to match known absolute path patterns.
    
    Parameters:
    
    path - The string to test.
    
    Returns:
    
    true if the specified string represents an absolute path, either system or public, otherwise false.
    
    Throws:
    
    NullPointerException - If path is null.
  - getProtocol
```
public static String getProtocol(String path)
```
    Returns the protocol section of the specified path, or null if a protocol section does not exist.
    
    Parameters:
    
    path - The path from which to get the protocol section.
    
    Returns:
    
    The protocol section of the specified path, or null if a protocol does not exist.
    
    Throws:
    
    NullPointerException - If path is null.
  - newPath
```
public static String newPath(String parent,
                             String child)
```
    Creates a path string from a parent pathname string and a child pathname string.
    This method operates with the following behavior:
    1. If child is empty then this method returns parent.
    2. If parent is null or empty then this method returns child.
    3. If parent does not have a trailing slash, and child does not have a leading slash, one slash is added.
    4. If parent has a trailing slash, and child has a leading slash, one slash is discarded.
    5. If parent is determined to be a Windows path, then the '\' character is used as the name separator (in case a separator character must be inserted); otherwise, '/' is used.
      
      Note: This method does not modify separator characters in any parameter.
    6. If child is absolute then it is converted into a relative pathname in a system-dependent way.
    7. Otherwise child is resolved against parent.
    Parameters:
    
    parent - The parent pathname string.
    
    child - The child pathname string.
    
    Returns:
    
    A path string from a parent pathname string and a child pathname string.
    
    Throws:
    
    NullPointerException - If @parent or child is null.
    
    See Also:
    
    isAbsoluteLocalWindows(String)
  - canonicalize
```
public static String canonicalize(String path)
```
    Returns the canonical form of the specified path, where ".." and "." path names are dereferenced, and redundant '/' (or '\' for Windows) path separators are removed.
    This implementation differs from File.getCanonicalPath() by only canonicalizing the superficial form of the specified path. This implementation does not perform filesystem interaction, for the purpose of operations such as resolving symbolic links (on UNIX platforms).
    
    Parameters:
    
    path - The path to canonicalize.
    
    Returns:
    
    The canonical form of the specified path, where ".." and "." path names are dereferenced, and redundant '/' (or '\' for Windows) path separators are removed.
    
    Throws:
    
    NullPointerException - If path is null.
  - canonicalize
```
public static StringBuilder canonicalize(StringBuilder path)
```
    Returns the canonical form of the specified path, where ".." and "." path names are dereferenced, and redundant '/' path separators are removed.
    This implementation differs from File.getCanonicalPath() by only canonicalizing the superficial form of the specified path. This implementation does not perform filesystem interaction, for the purpose of operations such as resolving symbolic links (on UNIX platforms).
    
    Parameters:
    
    path - The path to canonicalize.
    
    Returns:
    
    The canonicalized path instance, where ".." and "." path names are dereferenced, and redundant '/' path separators are removed.
    
    Throws:
    
    NullPointerException - If path is null.
  - getParent
```
public static String getParent(String path)
```
    Returns the pathname of the parent of path, or null if path does not name a parent directory.
    
    Parameters:
    
    path - The path string.
    
    Returns:
    
    The pathname of the parent of path, or null if path does not name a parent directory.
    
    Throws:
    
    NullPointerException - If path is null.
  - getCanonicalParent
```
public static String getCanonicalParent(String path)
```
    Returns the canonical pathname of the parent of path, or null if path does not name a parent directory. In a canonical path, the ".." and "." path names are dereferenced, and redundant '/' path separators are removed.
    
    Parameters:
    
    path - The path string.
    
    Returns:
    
    The canonical pathname of the parent of path, or null if path does not name a parent directory.
    
    Throws:
    
    NullPointerException - If path is null.
  - getName
```
public static String getName(String path)
```
    Returns the name of the file or directory denoted by the specified pathname. This is just the last name in the name sequence of path. If the name sequence of path is empty, then the empty string is returned.
    
    Parameters:
    
    path - The path string.
    
    Returns:
    
    The name of the file or directory denoted by the specified pathname, or the empty string if the name sequence of path is empty.
    
    Throws:
    
    IllegalArgumentException - If path is an empty string.
    
    NullPointerException - If path is null.
  - getShortName
```
public static String getShortName(String path)
```
    Returns the short name of the file or directory denoted by the specified pathname. This is just the last name in the name sequence of path, with its dot-extension removed, if present. If the name sequence of path is empty, then the empty string is returned.
    
    Parameters:
    
    path - The path string.
    
    Returns:
    
    The short name of the file or directory denoted by the specified pathname, or the empty string if the name sequence of path is empty.
    
    Throws:
    
    IllegalArgumentException - If path is an empty string.
    
    NullPointerException - If path is null.

Class StringPaths

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isAbsoluteLocalURL

isAbsoluteLocalUnix

isAbsoluteLocalWindows

isAbsoluteLocal

isAbsoluteSystemId

isAbsolutePublicId

isAbsolute

getProtocol

newPath

canonicalize

canonicalize

getParent

getCanonicalParent

getName

getShortName