Package nva.commons.core.paths

Class UriWrapper

java.lang.Object

nva.commons.core.paths.UriWrapper

public class UriWrapper
extends java.lang.Object

Class for easily building and manipulating URIs. Tools to easily append paths and not have to deal with checking whether the path delimiter is present or not.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EMPTY_FRAGMENT
static java.lang.String	EMPTY_PATH
static java.lang.String	EMPTY_QUERY
static java.lang.String	EMPTY_USER_INFO
static java.lang.String	HTTPS
static java.lang.String	MISSING_HOST
static java.lang.String	NULL_INPUT_ERROR

Constructor Summary

Constructors

Constructor	Description
UriWrapper(java.lang.String uri)	Deprecated, for removal: This API element is subject to removal in a future version. Use the static call fromUri(String) instead.
UriWrapper(java.lang.String scheme, java.lang.String host)
UriWrapper(java.net.URI uri)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
UriWrapper	addChild(java.lang.String... path)
UriWrapper	addChild(UnixPath childPath)	Appends a path to the URI.
UriWrapper	addQueryParameter(java.lang.String param, java.lang.String value)
UriWrapper	addQueryParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
static UriWrapper	fromHost(java.lang.String host)
static UriWrapper	fromHost(java.lang.String host, int port)
static UriWrapper	fromUri(java.lang.String uri)
static UriWrapper	fromUri(java.net.URI uri)
java.lang.String	getFilename()	Deprecated. User getLastPathElement
UriWrapper	getHost()
java.lang.String	getLastPathElement()
java.util.Optional<UriWrapper>	getParent()
UnixPath	getPath()
java.net.URI	getUri()
UnixPath	toS3bucketPath()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_FRAGMENT

public static final java.lang.String EMPTY_FRAGMENT

EMPTY_PATH

public static final java.lang.String EMPTY_PATH

EMPTY_USER_INFO

public static final java.lang.String EMPTY_USER_INFO

EMPTY_QUERY

public static final java.lang.String EMPTY_QUERY

MISSING_HOST

public static final java.lang.String MISSING_HOST

See Also:

Constant Field Values

HTTPS

public static final java.lang.String HTTPS

See Also:

Constant Field Values

NULL_INPUT_ERROR

public static final java.lang.String NULL_INPUT_ERROR

See Also:

Constant Field Values

Constructor Detail

UriWrapper

@Deprecated(forRemoval=true)
public UriWrapper(java.net.URI uri)

Deprecated, for removal: This API element is subject to removal in a future version.

UriWrapper

@Deprecated(forRemoval=true)
public UriWrapper(java.lang.String uri)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the static call fromUri(String) instead.

Utility for working with URIs in a consistent manner.

Parameters:

uri - the URI string

UriWrapper

public UriWrapper(java.lang.String scheme,
                  java.lang.String host)

Method Detail

fromUri

public static UriWrapper fromUri(java.net.URI uri)

fromUri

public static UriWrapper fromUri(java.lang.String uri)

fromHost

public static UriWrapper fromHost(java.lang.String host)

fromHost

public static UriWrapper fromHost(java.lang.String host,
                                  int port)

getUri

public java.net.URI getUri()

getHost

public UriWrapper getHost()

addChild

public UriWrapper addChild(java.lang.String... path)

addChild

public UriWrapper addChild(UnixPath childPath)

Appends a path to the URI.

Parameters:

childPath - the path to be appended.

Returns:

a UriWrapper containing the whole path.

toS3bucketPath

public UnixPath toS3bucketPath()

getPath

public UnixPath getPath()

getParent

public java.util.Optional<UriWrapper> getParent()

getLastPathElement

public java.lang.String getLastPathElement()

getFilename

@Deprecated(since="getLastPathElement was introduced")
public java.lang.String getFilename()

Deprecated.

User getLastPathElement

Returns the last element from the URI path.

Returns:

element.

addQueryParameter

public UriWrapper addQueryParameter(java.lang.String param,
                                    java.lang.String value)

addQueryParameters

public UriWrapper addQueryParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object