Class GenericUrl
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.
- Since:
- 1.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,
V>, AbstractMap.SimpleImmutableEntry<K, V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Fragment component ornull
for none.private String
Host, for example"www.google.com"
.Decoded path component by parts with each part separated by a'/'
ornull
for none, for example"/m8/feeds/contacts/default/full"
is represented by"", "m8", "feeds", "contacts", "default", "full"
.private int
Port number or-1
if undefined, for example443
.private String
Scheme (lowercase), for example"https"
.private static final Escaper
private String
User info ornull
for none, for example"username:password"
.private boolean
If true, the URL string originally given is used as is (without encoding, decoding and escaping) whenever referenced; otherwise, part of the URL string may be encoded or decoded as deemed appropriate or necessary. -
Constructor Summary
ConstructorsModifierConstructorDescriptionGenericUrl
(String encodedUrl) Constructs a GenericUrl from a URL encoded string.GenericUrl
(String encodedUrl, boolean verbatim) Constructs a GenericUrl from a string.private
GenericUrl
(String scheme, String host, int port, String path, String fragment, String query, String userInfo, boolean verbatim) GenericUrl
(URI uri) Constructs from a URI.GenericUrl
(URI uri, boolean verbatim) Constructs from a URI.GenericUrl
(URL url) Constructs from a URL.GenericUrl
(URL url, boolean verbatim) Constructs from a URL. -
Method Summary
Modifier and TypeMethodDescription(package private) static void
addQueryParams
(Set<Map.Entry<String, Object>> entrySet, StringBuilder buf, boolean verbatim) Adds query parameters from the provided entrySet into the buffer.private static boolean
appendParam
(boolean first, StringBuilder buf, String name, Object value, boolean verbatim) void
appendRawPath
(String encodedPath) Appends the given raw encoded path to the currentpathParts
, setting field only if it isnull
or empty.private void
final String
build()
Constructs the string representation of the URL, including the path specified bypathParts
and the query parameters specified by this generic URL.final String
Constructs the portion of the URL containing the scheme, host and port.final String
Constructs the portion of the URL beginning at the rooted path.clone()
Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.boolean
Returns all query parameter values for the given query parameter name.Returns the first query parameter value for the given query parameter name.Returns the fragment component ornull
for none.getHost()
Returns the host, for example"www.google.com"
.Returns the decoded path component by parts with each part separated by a'/'
ornull
for none.int
getPort()
Returns the port number or-1
if undefined, for example443
.Returns the raw encoded path computed from thepathParts
.final String
Returns the scheme (lowercase), for example"https"
.final String
Returns the user info ornull
for none, for example"username:password"
.int
hashCode()
private static URL
Returns the URI for the given encoded URL.Sets the given field value (may benull
) for the given field name.final void
setFragment
(String fragment) Sets the fragment component ornull
for none.final void
Sets the host, for example"www.google.com"
.void
setPathParts
(List<String> pathParts) Sets the decoded path component by parts with each part separated by a'/'
ornull
for none.final void
setPort
(int port) Sets the port number, for example443
.void
setRawPath
(String encodedPath) Sets thepathParts
from the given raw encoded path.final void
Sets the scheme (lowercase), for example"https"
.final void
setUserInfo
(String userInfo) Sets the user info ornull
for none, for example"username:password"
.toPathParts
(String encodedPath) Returns the decoded path parts for the given encoded path.toPathParts
(String encodedPath, boolean verbatim) Returns the path parts (decoded if notverbatim
).toString()
final URI
toURI()
Constructs the URI based on the string representation of the URL frombuild()
.private static URI
Returns the URI for the given encoded URL.final URL
toURL()
Constructs the URL based on the string representation of the URL frombuild()
.final URL
Constructs the URL based onURL(URL, String)
with this URL representation fromtoURL()
and a relative url.Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
URI_FRAGMENT_ESCAPER
-
scheme
Scheme (lowercase), for example"https"
. -
host
Host, for example"www.google.com"
. -
userInfo
User info ornull
for none, for example"username:password"
. -
port
private int portPort number or-1
if undefined, for example443
. -
pathParts
Decoded path component by parts with each part separated by a'/'
ornull
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. -
fragment
Fragment component ornull
for none. -
verbatim
private boolean verbatimIf true, the URL string originally given is used as is (without encoding, decoding and escaping) whenever referenced; otherwise, part of the URL string may be encoded or decoded as deemed appropriate or necessary.
-
-
Constructor Details
-
GenericUrl
public GenericUrl() -
GenericUrl
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 anIllegalArgumentException
.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.
- Parameters:
encodedUrl
- encoded URL, including any existing query parameters that should be parsed- Throws:
IllegalArgumentException
- if the URL has a syntax error
-
GenericUrl
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 anIllegalArgumentException
.- Parameters:
encodedUrl
- encoded URL, including any existing query parameters that should be parsedverbatim
- flag, to specify if URL should be used as is (without encoding, decoding and escaping)- Throws:
IllegalArgumentException
- if URL has a syntax error
-
GenericUrl
Constructs from a URI.- Parameters:
uri
- URI- Since:
- 1.14
-
GenericUrl
Constructs from a URI.- Parameters:
uri
- URIverbatim
- flag, to specify if URL should be used as is (without encoding, decoding and escaping)
-
GenericUrl
Constructs from a URL.- Parameters:
url
- URL- Since:
- 1.14
-
GenericUrl
Constructs from a URL.- Parameters:
url
- URLverbatim
- flag, to specify if URL should be used as is (without encoding, decoding and escaping)- Since:
- 1.14
-
GenericUrl
-
-
Method Details
-
hashCode
public int hashCode() -
equals
-
toString
- Overrides:
toString
in classGenericData
-
clone
Description copied from class:GenericData
Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.- Overrides:
clone
in classGenericData
-
set
Description copied from class:GenericData
Sets the given field value (may benull
) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient thanGenericData.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.
- Overrides:
set
in classGenericData
-
getScheme
Returns the scheme (lowercase), for example"https"
.- Since:
- 1.5
-
setScheme
Sets the scheme (lowercase), for example"https"
.- Since:
- 1.5
-
getHost
Returns the host, for example"www.google.com"
.- Since:
- 1.5
-
setHost
Sets the host, for example"www.google.com"
.- Since:
- 1.5
-
getUserInfo
Returns the user info ornull
for none, for example"username:password"
.- Since:
- 1.15
-
setUserInfo
Sets the user info ornull
for none, for example"username:password"
.- Since:
- 1.15
-
getPort
public int getPort()Returns the port number or-1
if undefined, for example443
.- Since:
- 1.5
-
setPort
public final void setPort(int port) Sets the port number, for example443
.- Since:
- 1.5
-
getPathParts
Returns the decoded path component by parts with each part separated by a'/'
ornull
for none.- Since:
- 1.5
-
setPathParts
Sets the decoded path component by parts with each part separated by a'/'
ornull
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.- Since:
- 1.5
-
getFragment
Returns the fragment component ornull
for none.- Since:
- 1.5
-
setFragment
Sets the fragment component ornull
for none.- Since:
- 1.5
-
build
Constructs the string representation of the URL, including the path specified bypathParts
and the query parameters specified by this generic URL. -
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:
- scheme://[user-info@]host[:port]
- Since:
- 1.9
-
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:
- path with with leading '/' if the path is non-empty, query parameters and fragment
- Since:
- 1.9
-
toURI
Constructs the URI based on the string representation of the URL frombuild()
.Any
URISyntaxException
is wrapped in anIllegalArgumentException
.- Returns:
- new URI instance
- Since:
- 1.14
-
toURL
Constructs the URL based on the string representation of the URL frombuild()
.Any
MalformedURLException
is wrapped in anIllegalArgumentException
.- Returns:
- new URL instance
- Since:
- 1.14
-
toURL
Constructs the URL based onURL(URL, String)
with this URL representation fromtoURL()
and a relative url.Any
MalformedURLException
is wrapped in anIllegalArgumentException
.- Returns:
- new URL instance
- Since:
- 1.14
-
getFirst
Returns the first query parameter value for the given query parameter name.- Parameters:
name
- query parameter name- Returns:
- first query parameter value
-
getAll
Returns all query parameter values for the given query parameter name.- Parameters:
name
- query parameter name- Returns:
- unmodifiable collection of query parameter values (possibly empty)
-
getRawPath
Returns the raw encoded path computed from thepathParts
. -
setRawPath
Sets thepathParts
from the given raw encoded path.- Parameters:
encodedPath
- raw encoded path ornull
to setpathParts
tonull
-
appendRawPath
Appends the given raw encoded path to the currentpathParts
, setting field only if it isnull
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"
.- Parameters:
encodedPath
- raw encoded path ornull
to ignore
-
toPathParts
Returns the decoded path parts for the given encoded path.- Parameters:
encodedPath
- slash-prefixed encoded path, for example"/m8/feeds/contacts/default/full"
- Returns:
- decoded path parts, with each part assumed to be preceded by a
'/'
, for example"", "m8", "feeds", "contacts", "default", "full"
, ornull
fornull
or""
input
-
toPathParts
Returns the path parts (decoded if notverbatim
).- Parameters:
encodedPath
- slash-prefixed encoded path, for example"/m8/feeds/contacts/default/full"
verbatim
- flag, to specify if URL should be used as is (without encoding, decoding and escaping)- Returns:
- path parts (decoded if not
verbatim
), with each part assumed to be preceded by a'/'
, for example"", "m8", "feeds", "contacts", "default", "full"
, ornull
fornull
or""
input
-
appendRawPathFromParts
-
addQueryParams
static void addQueryParams(Set<Map.Entry<String, Object>> entrySet, StringBuilder buf, boolean verbatim) Adds query parameters from the provided entrySet into the buffer. -
appendParam
private static boolean appendParam(boolean first, StringBuilder buf, String name, Object value, boolean verbatim) -
toURI
Returns the URI for the given encoded URL.Any
URISyntaxException
is wrapped in anIllegalArgumentException
.- Parameters:
encodedUrl
- encoded URL- Returns:
- URI
-
parseURL
Returns the URI for the given encoded URL.Any
MalformedURLException
is wrapped in anIllegalArgumentException
.- Parameters:
encodedUrl
- encoded URL- Returns:
- URL
-