protected abstract class

Service.ClientStreamProperties

extends Object
implements StreamProperties
java.lang.Object
   ↳ com.google.gdata.client.Service.ClientStreamProperties
Known Direct Subclasses

Class Overview

The ClientStreamProperties class is an abstract adaptor class that implements the StreamProperties interface for content to be written to or read from the target service based upon its attributes and a Service.GDataRequest.

Subclasses must implement the getContentType() method since the expected content type depends on the direction of data transfer for the request.

Summary

Fields
protected final UriParameterMap queryMap
protected final Service.GDataRequest req
Protected Constructors
Service.ClientStreamProperties(Service.GDataRequest req)
Service.ClientStreamProperties()
Public Methods
AltRegistry getAltRegistry()
Returns the AltRegistry that contains the set of supported representations and the parser/generator configuration for them.
ExtensionProfile getExtensionProfile()
Returns the ExtensionProfile associated with the stream.
Service.GDataRequest getGDataRequest()
String getQueryParameter(String name)
Returns the value of a request query parameter by name or null if not found.
Collection<String> getQueryParameterNames()
Returns a Collection that contains the name of all query parameters found in the request.
Version getRequestVersion()
boolean isPartial()
Protected Methods
AltFormat getAltFormat()
Returns the AltFormat describing the representation used for the current request.
MetadataContext getMetadataContext()
Returns a MetadataContext based upon the alt format and version of the request associated with these properties.
UriParameterMap getParameterMap()
Returns the UriParameterMap containing the decoded query parameters for the current request.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.google.gdata.wireformats.StreamProperties

Fields

protected final UriParameterMap queryMap

protected final Service.GDataRequest req

Protected Constructors

protected Service.ClientStreamProperties (Service.GDataRequest req)

Parameters
req

protected Service.ClientStreamProperties ()

Public Methods

public AltRegistry getAltRegistry ()

Returns the AltRegistry that contains the set of supported representations and the parser/generator configuration for them.

public ExtensionProfile getExtensionProfile ()

Returns the ExtensionProfile associated with the stream.

Returns
  • extension profile or null for requests that use the data model classes in com.google.gdata.model.

public Service.GDataRequest getGDataRequest ()

public String getQueryParameter (String name)

Returns the value of a request query parameter by name or null if not found.

Parameters
name

public Collection<String> getQueryParameterNames ()

Returns a Collection that contains the name of all query parameters found in the request.

public Version getRequestVersion ()

public boolean isPartial ()

Protected Methods

protected AltFormat getAltFormat ()

Returns the AltFormat describing the representation used for the current request.

Returns
  • alternate representation format for current request

protected MetadataContext getMetadataContext ()

Returns a MetadataContext based upon the alt format and version of the request associated with these properties. This can be used by subclasses to bind root element metadata for request or response types.

protected UriParameterMap getParameterMap ()

Returns the UriParameterMap containing the decoded query parameters for the current request.

Returns
  • query parameter map containing decoded query parameters