Class GenericUrl (1.42.2)

Stay organized with collections Save and categorize content based on your preferences.
public class GenericUrl extends GenericData

URL builder in which the query parameters are specified as generic data key/value pairs, based on the specification RFC 3986: Uniform Resource Identifier (URI).

The query parameters are specified with the data key name as the parameter name, and the data value as the parameter value. Subclasses can declare fields for known query parameters using the Key annotation. null parameter names are not allowed, but null query values are allowed.

Query parameter values are parsed using UrlEncodedParser#parse(String, Object).

Implementation is not thread-safe.

Inheritance

Object > AbstractMap > GenericData > GenericUrl

Static Methods

toPathParts(String encodedPath)

public static List<String> toPathParts(String encodedPath)

Returns the decoded path parts for the given encoded path.

Parameter
NameDescription
encodedPathString

slash-prefixed encoded path, for example "/m8/feeds/contacts/default/full"

Returns
TypeDescription
List<String>

decoded path parts, with each part assumed to be preceded by a '/', for example "", "m8", "feeds", "contacts", "default", "full", or null for null or "" input

toPathParts(String encodedPath, boolean verbatim)

public static List<String> toPathParts(String encodedPath, boolean verbatim)

Returns the path parts (decoded if not verbatim).

Parameters
NameDescription
encodedPathString

slash-prefixed encoded path, for example "/m8/feeds/contacts/default/full"

verbatimboolean

flag, to specify if URL should be used as is (without encoding, decoding and escaping)

Returns
TypeDescription
List<String>

path parts (decoded if not verbatim), with each part assumed to be preceded by a '/', for example "", "m8", "feeds", "contacts", "default", "full", or null for null or "" input

Constructors

GenericUrl()

public GenericUrl()

GenericUrl(String encodedUrl)

public GenericUrl(String encodedUrl)

Constructs a GenericUrl from a URL encoded string.

Any known query parameters with pre-defined fields as data keys will be parsed based on their data type. Any unrecognized query parameter will always be parsed as a string.

Any MalformedURLException is wrapped in an IllegalArgumentException.

Upgrade warning: starting in version 1.18 this parses the encodedUrl using new URL(encodedUrl). In previous versions it used new URI(encodedUrl). In particular, this means that only a limited set of schemes are allowed such as "http" and "https", but that parsing is compliant with, at least, RFC 3986.

Parameter
NameDescription
encodedUrlString

encoded URL, including any existing query parameters that should be parsed

GenericUrl(String encodedUrl, boolean verbatim)

public GenericUrl(String encodedUrl, boolean verbatim)

Constructs a GenericUrl from a string.

Any known query parameters with pre-defined fields as data keys will be parsed based on their data type. Any unrecognized query parameter will always be parsed as a string.

Any MalformedURLException is wrapped in an IllegalArgumentException.

Parameters
NameDescription
encodedUrlString

encoded URL, including any existing query parameters that should be parsed

verbatimboolean

flag, to specify if URL should be used as is (without encoding, decoding and escaping)

GenericUrl(URI uri)

public GenericUrl(URI uri)

Constructs from a URI.

Parameter
NameDescription
uriURI

URI

GenericUrl(URI uri, boolean verbatim)

public GenericUrl(URI uri, boolean verbatim)

Constructs from a URI.

Parameters
NameDescription
uriURI

URI

verbatimboolean

flag, to specify if URL should be used as is (without encoding, decoding and escaping)

GenericUrl(URL url)

public GenericUrl(URL url)

Constructs from a URL.

Parameter
NameDescription
urlURL

URL

GenericUrl(URL url, boolean verbatim)

public GenericUrl(URL url, boolean verbatim)

Constructs from a URL.

Parameters
NameDescription
urlURL

URL

verbatimboolean

flag, to specify if URL should be used as is (without encoding, decoding and escaping)

Methods

appendRawPath(String encodedPath)

public void appendRawPath(String encodedPath)

Appends the given raw encoded path to the current #pathParts, setting field only if it is null or empty.

The last part of the #pathParts is merged with the first part of the path parts computed from the given encoded path. Thus, if the current raw encoded path is "a", and the given encoded path is "b", then the resulting raw encoded path is "ab".

Parameter
NameDescription
encodedPathString

raw encoded path or null to ignore

build()

public final String build()

Constructs the string representation of the URL, including the path specified by #pathParts and the query parameters specified by this generic URL.

Returns
TypeDescription
String

buildAuthority()

public final String buildAuthority()

Constructs the portion of the URL containing the scheme, host and port.

For the URL "http://example.com/something?action=add" this method would return "http://example.com".

Returns
TypeDescription
String

scheme://[user-info@]host[:port]

buildRelativeUrl()

public final String buildRelativeUrl()

Constructs the portion of the URL beginning at the rooted path.

For the URL "http://example.com/something?action=add" this method would return "/something?action=add".

Returns
TypeDescription
String

path with with leading '/' if the path is non-empty, query parameters and fragment

clone()

public GenericUrl clone()

Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.

Returns
TypeDescription
GenericUrl
Overrides

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAll(String name)

public Collection<Object> getAll(String name)

Returns all query parameter values for the given query parameter name.

Parameter
NameDescription
nameString

query parameter name

Returns
TypeDescription
Collection<Object>

unmodifiable collection of query parameter values (possibly empty)

getFirst(String name)

public Object getFirst(String name)

Returns the first query parameter value for the given query parameter name.

Parameter
NameDescription
nameString

query parameter name

Returns
TypeDescription
Object

first query parameter value

getFragment()

public String getFragment()

Returns the fragment component or null for none.

Returns
TypeDescription
String

getHost()

public String getHost()

Returns the host, for example "www.google.com".

Returns
TypeDescription
String

getPathParts()

public List<String> getPathParts()

Returns the decoded path component by parts with each part separated by a '/' or null for none.

Returns
TypeDescription
List<String>

getPort()

public int getPort()

Returns the port number or -1 if undefined, for example 443.

Returns
TypeDescription
int

getRawPath()

public String getRawPath()

Returns the raw encoded path computed from the #pathParts.

Returns
TypeDescription
String

raw encoded path computed from the #pathParts or null if #pathParts is null

getScheme()

public final String getScheme()

Returns the scheme (lowercase), for example "https".

Returns
TypeDescription
String

getUserInfo()

public final String getUserInfo()

Returns the user info or null for none, for example "username:password".

Returns
TypeDescription
String

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

set(String fieldName, Object value)

public GenericUrl set(String fieldName, Object value)

Sets the given field value (may be null) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient than #put(String, Object) because it avoids accessing the field's original value.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters
NameDescription
fieldNameString
valueObject
Returns
TypeDescription
GenericUrl
Overrides

setFragment(String fragment)

public final void setFragment(String fragment)

Sets the fragment component or null for none.

Parameter
NameDescription
fragmentString

setHost(String host)

public final void setHost(String host)

Sets the host, for example "www.google.com".

Parameter
NameDescription
hostString

setPathParts(List<String> pathParts)

public void setPathParts(List<String> pathParts)

Sets the decoded path component by parts with each part separated by a '/' or null for none.

For example "/m8/feeds/contacts/default/full" is represented by "", "m8", "feeds", "contacts", "default", "full".

Use #appendRawPath(String) to append to the path, which ensures that no extra slash is added.

Parameter
NameDescription
pathPartsList<String>

setPort(int port)

public final void setPort(int port)

Sets the port number, for example 443.

Parameter
NameDescription
portint

setRawPath(String encodedPath)

public void setRawPath(String encodedPath)

Sets the #pathParts from the given raw encoded path.

Parameter
NameDescription
encodedPathString

raw encoded path or null to set #pathParts to null

setScheme(String scheme)

public final void setScheme(String scheme)

Sets the scheme (lowercase), for example "https".

Parameter
NameDescription
schemeString

setUserInfo(String userInfo)

public final void setUserInfo(String userInfo)

Sets the user info or null for none, for example "username:password".

Parameter
NameDescription
userInfoString

toString()

public String toString()
Returns
TypeDescription
String
Overrides

toURI()

public final URI toURI()

Constructs the URI based on the string representation of the URL from #build().

Any URISyntaxException is wrapped in an IllegalArgumentException.

Returns
TypeDescription
URI

new URI instance

toURL()

public final URL toURL()

Constructs the URL based on the string representation of the URL from #build().

Any MalformedURLException is wrapped in an IllegalArgumentException.

Returns
TypeDescription
URL

new URL instance

toURL(String relativeUrl)

public final URL toURL(String relativeUrl)

Constructs the URL based on URL#URL(URL, String) with this URL representation from #toURL() and a relative url.

Any MalformedURLException is wrapped in an IllegalArgumentException.

Parameter
NameDescription
relativeUrlString
Returns
TypeDescription
URL

new URL instance