Package dev.enola.common.io.iri

Class URIs

java.lang.Object

dev.enola.common.io.iri.URIs

public final class URIs
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	URIs.ContextKeys
static final record	URIs.MediaTypeAndOrCharset

Method Summary

Modifier and Type	Method	Description
static String	absolutify(String uri)
static URI	absolutify(URI uri)
static URI	addCharset(URI uri, Charset charset)
static URI	addFragment(URI uri, String fragment)
static URI	addMediaType(URI uri, MediaType mediaType)
static String	addQuery(String string, Map<String,String> parameters)
static URI	addQuery(URI uri, URI originalUriWithQuery)	Returns an URI with everything except the query parameters of the uri (1st) parameter, but the query parameters of originalUriWithQuery (2nd) parameter - IFF the uri (1st) parameter has no query; otherwise just returns the uri (1st) parameter as-is.
static URI	addQuery(URI uri, Map<String,String> parameters)
static String	dropQueryAndFragment(String uri)
static URI	dropQueryAndFragment(URI uri)
static String	encode(String uri)	Deprecated.
static URI	getBase(URI uri)
static @Nullable String	getCharset(URI uri)
static String	getFilename(URI uri)	Extracts the "file name" from an URI, or the empty string if there is none.
static String	getFilenameOrLastPathSegmentOrHost(URI uri)
static String	getFilenameWithoutExtension(URI uri, String... extensions)
static Path	getFilePath(String uri)
static Path	getFilePath(URI uri)	Get a Path from an URI.
static URIs.MediaTypeAndOrCharset	getMediaTypeAndCharset(URI uri)
static String	getPath(String uri)
static String	getPath(URI uri)	Deprecated.
static Map<String,String>	getQueryMap(String uri)
static Map<String,String>	getQueryMap(URI uri)
static String	getScheme(String iri)
static boolean	hasExtension(URI uri, String... extensions)
static boolean	hasQueryParameter(URI uri, String key)
static boolean	hasScheme(String iri)
static URI	parse(String uri)
static URI	rel2abs(URI uri)	Deprecated.

Methods inherited from class java.lang.Object

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

Method Details

hasQueryParameter

public static boolean hasQueryParameter(URI uri,
 String key)

getMediaTypeAndCharset

public static URIs.MediaTypeAndOrCharset getMediaTypeAndCharset(URI uri)

getCharset

public static @Nullable String getCharset(URI uri)

addMediaType

public static URI addMediaType(URI uri,
 MediaType mediaType)

addCharset

public static URI addCharset(URI uri,
 Charset charset)

addQuery

public static URI addQuery(URI uri,
 Map<String,String> parameters)

addQuery

public static URI addQuery(URI uri,
 URI originalUriWithQuery)

Returns an URI with everything except the query parameters of the uri (1st) parameter, but the query parameters of originalUriWithQuery (2nd) parameter - IFF the uri (1st) parameter has no query; otherwise just returns the uri (1st) parameter as-is.

For example, this method can be used to preserve query parameters when changing the URI path.

addQuery

public static String addQuery(String string,
 Map<String,String> parameters)

getQueryMap

public static Map<String,String> getQueryMap(String uri)

getQueryMap

public static Map<String,String> getQueryMap(URI uri)

getFilePath

public static Path getFilePath(URI uri)

Get a Path from an URI. This method is used internally by dev.enola.common.io.resource.Resource framework implementations, and typically shouldn't be called directly by users. Please see the dev.enola.common.io.resource.FileResource for more related background.

getFilePath

public static Path getFilePath(String uri)

getScheme

public static String getScheme(String iri)

hasScheme

public static boolean hasScheme(String iri)

getPath

@Deprecated
public static String getPath(URI uri)

Deprecated.

Get the "path"-like component of any URI. Similar to URI.getPath(), but also works e.g. for "non-standard" relative "file:hello.txt" URIs, and correctly chops off query arguments and fragments.

TODO This does not yet decode correctly! :=((

TODO Is this really required?! Re-review which tests URI#getPath() fails, and why...

getPath

public static String getPath(String uri)

getFilename

public static String getFilename(URI uri)

Extracts the "file name" from an URI, or the empty string if there is none. The filename is simply the last part of the path of the URI. It COULD be a directory! Works for file: http: and other even for "weird" URIs, such as those from Classpath URLs.

See also Files.getFileExtension(String) and @Files.getNameWithoutExtension(String).

getFilenameWithoutExtension

public static String getFilenameWithoutExtension(URI uri,
 String... extensions)

hasExtension

public static boolean hasExtension(URI uri,
 String... extensions)

getFilenameOrLastPathSegmentOrHost

public static String getFilenameOrLastPathSegmentOrHost(URI uri)

rel2abs

@Deprecated
public static URI rel2abs(URI uri)

Deprecated.

This converts e.g. "file:relative.txt" to "file:///tmp/.../relative.txt" (depending on the current working directory, obviously). It loses any query parameters and fragments.

absolutify

public static URI absolutify(URI uri)

absolutify

public static String absolutify(String uri)

dropQueryAndFragment

public static URI dropQueryAndFragment(URI uri)

dropQueryAndFragment

public static String dropQueryAndFragment(String uri)

getBase

public static URI getBase(URI uri)
                   throws IOException

Throws:

IOException

addFragment

public static URI addFragment(URI uri,
 String fragment)

encode

@Deprecated
public static String encode(String uri)

Deprecated.

parse

public static URI parse(String uri)
                 throws URISyntaxException

Throws:

URISyntaxException