Represents scp-like URLs, for example: [email protected]:lemonlabsuk/scala-uri.git
From the scp
manpage: [user@]host:[path]
- Companion:
- object
Type members
Inherited types
Value members
Concrete methods
Copies this Url but with the authority set as the given value.
Copies this Url but with the authority set as the given value.
- Value parameters:
- authority
the authority host to set
- Returns:
a new Url with the specified authority
Copies this Url but with the fragment set as the given value.
Copies this Url but with the fragment set as the given value.
- Value parameters:
- fragment
the new fragment to set
- Returns:
a new Url with the specified fragment
Copies this Url but with the path set as the given value.
Copies this Url but with the path set as the given value.
- Value parameters:
- path
the new path to set
- Returns:
a new Url with the specified path
Copies this Url but with the query set as the given value.
Copies this Url but with the query set as the given value.
- Value parameters:
- query
the new QueryString to set
- Returns:
a new Url with the specified query
Inherited methods
Adds a new Query String parameter key-value pair.
Adds a new Query String parameter key-value pair.
Pairs with values, such as Some("value")
, represent query params with values, i.e ?param=value
By default, pairs without values, i.e None
, represent query params without values, i.e ?param
Using a UriConfig(renderQuery = ExcludeNones)
, will cause pairs with None
values not to be rendered
- Value parameters:
- k
value that provides a name pair for the parameter. Can be a any basic value type or a custom type if you provide a
QueryKey
type-class- v
value that provides a value for the parameter. Can be a any basic value type or a custom type if you provide a
QueryValue
type-class
- Returns:
A new Url with the new Query String parameter
- Inherited from:
- Url
Adds a new Query String parameter key-value pair.
Adds a new Query String parameter key-value pair.
Pairs with values, such as Some("value")
, represent query params with values, i.e ?param=value
By default, pairs without values, i.e None
, represent query params without values, i.e ?param
Using a UriConfig(renderQuery = ExcludeNones)
, will cause pairs with None
values not to be rendered
- Value parameters:
- a
value that provides a name/value pair for the parameter. Can be a Tuple of any basic value types or a custom type if you provide a
QueryKeyValue
type-class
- Returns:
A new Url with the new Query String parameter
- Inherited from:
- Url
Adds all the specified key-value pairs as parameters to the query
Adds all the specified key-value pairs as parameters to the query
- Value parameters:
- params
A list of key-value pairs to add as query parameters
- Returns:
A new Url with the new Query String parameters
- Inherited from:
- Url
Adds all the specified key-value pairs as parameters to the query
Adds all the specified key-value pairs as parameters to the query
- Value parameters:
- params
A list of key-value pairs to add as query parameters
- Returns:
A new Url with the new Query String parameters
- Inherited from:
- Url
Returns the apex domain for this URL.
Returns the apex domain for this URL.
The apex domain is constructed from the public suffix for this URL's host prepended with the immediately preceding dot segment.
Examples include:
example.com
for www.example.com
example.co.uk
for www.example.co.uk
- Returns:
the apex domain for this URL
- Inherited from:
- Url
Transforms the Query String by applying the specified PartialFunction to each Query String Parameter
Transforms the Query String by applying the specified PartialFunction to each Query String Parameter
Parameters not defined in the PartialFunction will be removed.
- Value parameters:
- f
A function that returns a new Parameter when applied to each Parameter
- Inherited from:
- Url
Removes any Query String Parameters that return false when applied to the given Function
Removes any Query String Parameters that return false when applied to the given Function
- Inherited from:
- Url
Removes any Query String Parameters that return false when their name is applied to the given Function
Removes any Query String Parameters that return false when their name is applied to the given Function
- Inherited from:
- Url
Removes any Query String Parameters that return false when their value is applied to the given Function
Removes any Query String Parameters that return false when their value is applied to the given Function
- Inherited from:
- Url
Transforms the Query String by applying the specified Function to each Query String Parameter
Transforms the Query String by applying the specified Function to each Query String Parameter
- Value parameters:
- f
A function that returns a collection of Parameters when applied to each parameter
- Inherited from:
- Url
Returns the longest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a.b.c.example
Returns the longest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a.b.c.example
- Returns:
the longest subdomain for this URL's host
- Inherited from:
- UrlWithAuthority
Transforms this URL by applying the specified Function to the password if it exists
Transforms this URL by applying the specified Function to the password if it exists
- Definition Classes
- Inherited from:
- UrlWithAuthority
Transforms the Query String by applying the specified PartialFunction to each Query String Parameter
Transforms the Query String by applying the specified PartialFunction to each Query String Parameter
Parameters not defined in the PartialFunction will be left as-is.
- Value parameters:
- f
A function that returns a new Parameter when applied to each Parameter
- Inherited from:
- Url
Transforms the Query String by applying the specified Function to each Query String Parameter name
Transforms the Query String by applying the specified Function to each Query String Parameter name
- Value parameters:
- f
A function that returns a new Parameter name when applied to each Parameter name
- Inherited from:
- Url
Transforms the Query String by applying the specified Function to each Query String Parameter value
Transforms the Query String by applying the specified Function to each Query String Parameter value
- Value parameters:
- f
A function that returns a new Parameter value when applied to each Parameter value
- Inherited from:
- Url
Transforms this URL by applying the specified Function to the user if it exists
Transforms this URL by applying the specified Function to the user if it exists
- Definition Classes
- Inherited from:
- UrlWithAuthority
Returns the longest public suffix for the host in this URI. Examples include:
com
for www.example.com
co.uk
for www.example.co.uk
Returns the longest public suffix for the host in this URI. Examples include:
com
for www.example.com
co.uk
for www.example.co.uk
- Returns:
the longest public suffix for the host in this URI
- Inherited from:
- UrlWithAuthority
Returns all longest public suffixes for the host in this URI. Examples include:
com
for www.example.com
co.uk
and uk
for www.example.co.uk
Returns all longest public suffixes for the host in this URI. Examples include:
com
for www.example.com
co.uk
and uk
for www.example.co.uk
- Returns:
all public suffixes for the host in this URI
- Inherited from:
- UrlWithAuthority
Removes all Query String parameters with a name in the specified list
Removes all Query String parameters with a name in the specified list
- Value parameters:
- k
Names of Query String parameter(s) to remove
- Inherited from:
- Url
Removes all Query String parameters with a name in the specified list
Removes all Query String parameters with a name in the specified list
- Value parameters:
- first
Name of a Query String parameter to remove
- rest
Name of more Query String parameter(s) to remove
- second
Name of another Query String parameter to remove
- Inherited from:
- Url
Removes all Query String parameters with the specified key
Removes all Query String parameters with the specified key
- Value parameters:
- k
Key for the Query String parameter(s) to remove
- Inherited from:
- Url
Removes any password from this URL
Removes any password from this URL
- Returns:
This URL without the password
- Inherited from:
- UrlWithAuthority
Removes any user from this URL
Removes any user from this URL
- Returns:
This URL without the user
- Inherited from:
- UrlWithAuthority
Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.
Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.
Pairs with values, such as ("param", Some("value"))
, represent query params with values, i.e ?param=value
By default, pairs without values, such as ("param", None)
, represent query params without values, i.e ?param
Using a UriConfig(renderQuery = ExcludeNones)
, will cause pairs with None
values not to be rendered
- Value parameters:
- k
Key for the Query String parameter(s) to replace
- v
value to replace with
- Returns:
A new Uri with the result of the replace
- Inherited from:
- Url
Returns the shortest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a
Returns the shortest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a
- Returns:
the shortest subdomain for this URL's host
- Inherited from:
- UrlWithAuthority
Returns the second largest subdomain for this URL's host.
Returns the second largest subdomain for this URL's host.
E.g. for http://a.b.c.example.com returns a.b.c
Note: In the event there is only one subdomain (i.e. the host is the apex domain), this method returns None
.
E.g. This method will return None
for http://example.com
.
- Returns:
the second largest subdomain for this URL's host
- Inherited from:
- UrlWithAuthority
Returns all subdomains for this URL's host. E.g. for http://a.b.c.example.com returns a, a.b, a.b.c and a.b.c.example
Returns all subdomains for this URL's host. E.g. for http://a.b.c.example.com returns a, a.b, a.b.c and a.b.c.example
- Returns:
all subdomains for this URL's host
- Inherited from:
- UrlWithAuthority
Converts to a java.net.URI
Converts to a java.net.URI
This involves a toString
and URI.parse
because the specific java.net.URI
constructors do not deal properly with encoded elements
- Returns:
a
java.net.URI
matching thisio.lemonlabs.uri.Uri
- Inherited from:
- Uri
- Returns:
the URL as a String. If the URI has a domain name for a host, any unicode characters will be returned in ASCII Compatible Encoding (ACE), as defined by the ToASCII operation of RFC 3490.
- Definition Classes
- Inherited from:
- UrlWithAuthority
Returns the path with no encoders taking place (e.g. non ASCII characters will not be percent encoded)
Returns the path with no encoders taking place (e.g. non ASCII characters will not be percent encoded)
- Returns:
String containing the raw path for this Uri
- Inherited from:
- Uri
Copies this Url but with the host set as the given value.
Copies this Url but with the host set as the given value.
- Value parameters:
- host
the new host to set
- Returns:
a new Url with the specified host
- Inherited from:
- Url
Copies this Url but with the password set as the given value.
Copies this Url but with the password set as the given value.
- Value parameters:
- password
the new password to set
- Returns:
a new Url with the specified password
- Inherited from:
- UrlWithAuthority
Copies this Url but with the path set as the given value.
Copies this Url but with the path set as the given value.
- Value parameters:
- parts
the parts that make up the new path
- Returns:
a new Url with the specified path
- Inherited from:
- Url
Copies this Url but with the port set as the given value.
Copies this Url but with the port set as the given value.
- Value parameters:
- port
the new port to set
- Returns:
a new Url with the specified port
- Inherited from:
- UrlWithAuthority
Replaces the all existing Query String parameters with a new set of query params
Replaces the all existing Query String parameters with a new set of query params
- Inherited from:
- Url
Replaces the all existing Query String parameters with a new set of query params
Replaces the all existing Query String parameters with a new set of query params
- Inherited from:
- Url
Copies this Url but with the user set as the given value.
Copies this Url but with the user set as the given value.
- Value parameters:
- user
the new user to set
- Returns:
a new Url with the specified user
- Inherited from:
- UrlWithAuthority