com.google.api.client.googleapis
Class GoogleUrl

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.http.GenericUrl
              com.google.api.client.googleapis.GoogleUrl

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

GoogleOAuthDomainWideDelegation.Url

public class GoogleUrl
extends GenericUrl

Generic Google URL providing for some common query parameters used in Google API's such as the alt and fields parameters.

Since:

1.0

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

String	alt Alternate wire format.
String	fields Partial fields mask.
String	key API key as described in the Google APIs Console documentation.
Boolean	prettyprint Whether to pretty print the output.
String	userip User IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.

Fields inherited from class com.google.api.client.http.GenericUrl

fragment, host, pathParts, port, scheme

Fields inherited from class com.google.api.client.util.GenericData

unknownFields

Constructor Summary

GoogleUrl()

GoogleUrl(String encodedUrl)

Method Summary

GoogleUrl	clone()
static GoogleUrl	create(String encodedServerUrl, String pathTemplate, Object parameters) Construct a GoogleUrl from a server, template and a parameter block.

Methods inherited from class com.google.api.client.http.GenericUrl

appendRawPath, build, equals, getAll, getFirst, getFragment, getHost, getPathParts, getPort, getRawPath, getScheme, hashCode, setFragment, setHost, setPathParts, setPort, setRawPath, setScheme, toPathParts, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getUnknownKeys, put, putAll, remove, set, 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

Field Detail

prettyprint

public Boolean prettyprint

Whether to pretty print the output.

alt

public String alt

Alternate wire format.

fields

public String fields

Partial fields mask.

key

public String key

API key as described in the Google APIs Console documentation.

Since:

1.3

userip

public String userip

User IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.

Since:

1.3

Constructor Detail

GoogleUrl

public GoogleUrl()

GoogleUrl

public GoogleUrl(String encodedUrl)

Parameters:

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

Method Detail

clone

public GoogleUrl clone()

Overrides:

clone in class GenericUrl

create

public static GoogleUrl create(String encodedServerUrl,
                               String pathTemplate,
                               Object parameters)
                        throws IllegalArgumentException

Construct a GoogleUrl from a server, template and a parameter block.

Parameters:

encodedServerUrl - encoded URL of the server

pathTemplate - path template

parameters - an object with parameters designated by Key annotations. If the template has no variable references, parameters may be null.

Throws:

IllegalArgumentException - if a requested element in the pathTemplate is not in the parameters

Since:

1.3