org.daisy.common.file

Class URLs

java.lang.Object

org.daisy.common.file.URLs

public final class URLs
extends Object

A collection of URI related utility functions.

Method Summary

Modifier and Type	Method and Description
static Path	asPath(URI uri) Convert an absolute file URI to a Path denoting a file or an entry in a zip file.
static URI	asURI(File file)
static URI	asURI(String url)
static URI	asURI(URL url)
static URL	asURL(File file)
static URL	asURL(String url)
static URL	asURL(URI url)
static URI	encode(URL url)
static URI	expand83(File file)
static String	expand83(String uri) Expand 8.3 encoded path segments.
static File	getCurrentJAR(Class<?> context)
static URL	getResourceFromJAR(String resource, Class<?> context)
static Path	getResourceFromJAR(String resource, Path jarFilePath) Closing the file system of the returned path is the responsibility of the caller.
static Iterator<String>	listResourcesFromJAR(String directory, Class<?> context)
static Iterator<String>	listResourcesFromJAR(String directory, Path jarFilePath)
static URI	normalize(URI uri)
static URI	normalize(URI uri, boolean dropFragment)
static URI	relativize(URI base, URI uri) Relativize a URI against a base URI.
static URI	resolve(URI base, URI url)

Methods inherited from class java.lang.Object

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

Method Detail

asURL

public static URL asURL(File file)

Parameters:

file - A file

asURL

public static URL asURL(String url)

Parameters:

url - An encoded absolute URL

Throws:

IllegalArgumentException

asURL

public static URL asURL(URI url)

Parameters:

url - An encoded absolute URL

Throws:

IllegalArgumentException

asURI

public static URI asURI(File file)

Parameters:

url - A file

asURI

public static URI asURI(String url)

Parameters:

url - An encoded absolute or relative URL

Throws:

IllegalArgumentException

asURI

public static URI asURI(URL url)

Parameters:

url - An encoded absolute or relative URL

Throws:

IllegalArgumentException

asPath

public static Path asPath(URI uri)
                   throws IllegalArgumentException,
                          URISyntaxException

Convert an absolute file URI to a Path denoting a file or an entry in a zip file.

Throws:

IllegalArgumentException

URISyntaxException

encode

public static URI encode(URL url)

Parameters:

url - An unencoded absolute URL

Returns:

An encoded absolute URL

resolve

public static URI resolve(URI base,
                          URI url)

Parameters:

base - An encoded absolute or relative URL

url - An encoded absolute or relative URL

Returns:

An encoded absolute or relative URL

relativize

public static URI relativize(URI base,
                             URI uri)

Relativize a URI against a base URI. This functions differs from URI.relativize(java.net.URI) in that it is also able to find relative paths when the URI does not start with the base URI (in which case the resulting URI will contain ".." segments).

Parameters:

base - An encoded absolute or relative URL

url - An encoded absolute or relative URL

Returns:

An encoded absolute or relative URL

normalize

public static URI normalize(URI uri)

normalize

public static URI normalize(URI uri,
                            boolean dropFragment)

expand83

public static String expand83(String uri)
                       throws URISyntaxException,
                              IOException

Expand 8.3 encoded path segments. For instance `C:\DOCUME~1\file.xml` will become `C:\Documents and Settings\file.xml`

Throws:

URISyntaxException

IOException

expand83

public static URI expand83(File file)
                    throws URISyntaxException,
                           IOException

Throws:

URISyntaxException

IOException

getResourceFromJAR

public static URL getResourceFromJAR(String resource,
                                     Class<?> context)

Parameters:

resource - The (not URL-encoded) path of a resource inside the specified JAR or class directory

context - A class from the JAR or class directory that is to be searched for resources

Returns:

An encoded absolute URL

getCurrentJAR

public static File getCurrentJAR(Class<?> context)

getResourceFromJAR

public static Path getResourceFromJAR(String resource,
                                      Path jarFilePath)

Closing the file system of the returned path is the responsibility of the caller.

listResourcesFromJAR

public static Iterator<String> listResourcesFromJAR(String directory,
                                                    Class<?> context)

Parameters:

directory - The (not URL-encoded) path of a directory inside the specified JAR or class directory

context - A class from the JAR or class directory that is to be searched for resources

Returns:

A list of resource paths (not URL-encoded)

listResourcesFromJAR

public static Iterator<String> listResourcesFromJAR(String directory,
                                                    Path jarFilePath)

Parameters:

directory - The (not URL-encoded) path of a directory inside the specified JAR or class directory

jarFilePath - The location of the JAR file in a file system. Does not need to be be representable by a File.

Returns:

A list of resource paths (not URL-encoded)