org.libj.net

Class URIs

java.lang.Object

org.libj.net.URIs

public final class URIs
extends Object

Utility functions for operations pertaining to URI.

Method Summary

Modifier and Type	Method and Description
static URI	fromURL(URL url) Creates a URI from the specified URL.
static URI	getCanonicalParent(URI uri) Returns the canonical URI representing the parent of the specified URI, or null if uri is null or does not name a parent directory (".." and "." path names are dereferenced in a canonical URI)).
static String	getName(URI uri) Returns the name of the file or directory denoted by the specified URI.
static URI	getParent(URI uri) Returns the URI representing the parent of the specified URI, or null if uri is null or does not name a parent directory.
static String	getShortName(URI uri) Returns the short name of the file or directory denoted by the specified URI.
static boolean	isLocal(URI uri) Tests whether the specified URI represents a location that is either a local file with scheme "file:", or a local JAR file with scheme "jar:file:".
static boolean	isLocalFile(URI uri) Tests whether the specified URI represents a file path.
static boolean	isLocalJarFile(URI uri) Tests whether the specified URI represents a location that is a local JAR file with scheme "jar:file:".
static URI	relativePath(URI from, URI to) Constructs a relative path between the specified from and provided to.
static URI	toURI(URI baseURI, String path) Returns an URI created from the specified baseURI parent URI, and path child path.

Methods inherited from class java.lang.Object

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

Method Detail

fromURL

public static URI fromURL(URL url)

Creates a URI from the specified URL.

This method functions in the same way as new URI(url.toString()).

Note, any URL instance that complies with RFC 2396 can be converted to a URI. However, some URLs that are not strictly in compliance can not be converted to a URI.

Parameters:

url - The URL to convert to a URI.

Returns:

The new URI.

Throws:

IllegalArgumentException - if this URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

NullPointerException - If the specified URL is null.

relativePath

public static URI relativePath(URI from,
                               URI to)

Constructs a relative path between the specified from and provided to.

Parameters:

from - The URI from which to start.

to - The URI to which to end up.

Returns:

The relativized URI, or null if either specified URIs are opaque.

Throws:

NullPointerException - If from or to is null.

isLocalFile

public static boolean isLocalFile(URI uri)

Tests whether the specified URI represents a file path. A URI is considered a file if its scheme is "file" (case-insensitive), and its host value is empty or equal to "localhost".

Parameters:

uri - The URI.

Returns:

true if the specified URI represents a file path; otherwise false.

Throws:

NullPointerException - If uri is null.

isLocalJarFile

public static boolean isLocalJarFile(URI uri)

Tests whether the specified URI represents a location that is a local JAR file with scheme "jar:file:".

The compound scheme definition is unwrapped in order to determine if the root resource locator in the URI is local. This method then uses isLocalFile(URI) to check whether uri is local.

Parameters:

uri - The URI to test.

Returns:

true if the specified URI represents a location that is local; otherwise false.

Throws:

NullPointerException - If uri is null.

isLocal

public static boolean isLocal(URI uri)

Tests whether the specified URI represents a location that is either a local file with scheme "file:", or a local JAR file with scheme "jar:file:".

URIs with compound scheme definitions, such as "jar:file:" are first unwrapped in order to digest the root resource locator in the URI. This method then uses isLocalFile(URI) to check whether uri is local.

Parameters:

uri - The URI to test.

Returns:

true if the specified URI represents a location that is either a local file with scheme "file:", or a local JAR file with scheme "jar:file:"; otherwise false.

Throws:

NullPointerException - If uri is null.

getName

public static String getName(URI uri)

Returns the name of the file or directory denoted by the specified URI. This is just the last name in the name sequence of uri. If the name sequence of uri is empty, then the empty string is returned.

Parameters:

uri - The URI.

Returns:

The name of the file or directory denoted by the specified URI, or the empty string if the name sequence of uri is empty.

Throws:

NullPointerException - If uri is null.

getShortName

public static String getShortName(URI uri)

Returns the short name of the file or directory denoted by the specified URI. This is just the last name in the name sequence of uri, with its dot-extension removed if present. If the name sequence of uri is empty, then the empty string is returned.

Parameters:

uri - The URI.

Returns:

The short name of the file or directory denoted by the specified URI, or the empty string if the name sequence of uri is empty.

Throws:

NullPointerException - If uri is null.

getParent

public static URI getParent(URI uri)

Returns the URI representing the parent of the specified URI, or null if uri is null or does not name a parent directory.

Parameters:

uri - The URI.

Returns:

The URI representing the parent of the specified URI, or null if uri does not name a parent directory.

See Also:

StringPaths.getParent(String)

getCanonicalParent

public static URI getCanonicalParent(URI uri)

Returns the canonical URI representing the parent of the specified URI, or null if uri is null or does not name a parent directory (".." and "." path names are dereferenced in a canonical URI)).

Parameters:

uri - The URI.

Returns:

The URI representing the parent of the specified URI, or null if uri is null or does not name a parent directory (".." and "." path names are dereferenced in a canonical URI, and redundant '/' path separators are removed).

See Also:

StringPaths.getParent(String)

toURI

public static URI toURI(URI baseURI,
                        String path)

Returns an URI created from the specified baseURI parent URI, and path child path.

Parameters:

baseURI - The base URI of the path in the resulting URI.

path - The child path off of baseURI in the resulting URI.

Returns:

An URI created from the specified baseURI parent directory, and path child path.

Throws:

IllegalArgumentException - If the specified baseURI contains a query string; if both a scheme and a path are given but the path is relative, if the URI string constructed from the given components violates RFC 2396, or if the authority component of the string is present but cannot be parsed as a server-based authority.

NullPointerException - If baseURI or path is null.